RegistrationFlow class abstract

RegistrationFlow

Properties:

  • active - Active, if set, contains the registration method that is being used. It is initially not set. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode
  • expiresAt - ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.
  • id - ID represents the flow's unique ID. When performing the registration flow, this represents the id in the registration ui's query parameter: http://<selfservice.flows.registration.ui_url>/?flow=
  • issuedAt - IssuedAt is the time (UTC) when the flow occurred.
  • oauth2LoginChallenge - Ory OAuth 2.0 Login Challenge. This value is set using the login_challenge query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.
  • oauth2LoginRequest
  • organizationId
  • requestUrl - RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example.
  • returnTo - ReturnTo contains the requested return_to URL.
  • sessionTokenExchangeCode - SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type "api", and only on creating the flow.
  • state - State represents the state of this request: choose_method: ask the user to choose a method (e.g. registration with email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the registration challenge was passed.
  • transientPayload - TransientPayload is used to pass data from the registration to a webhook
  • type - The flow type can either be api or browser.
  • ui
Annotations
  • @BuiltValue()

Constructors

RegistrationFlow([void updates(RegistrationFlowBuilder b)])
factory

Properties

active → RegistrationFlowActiveEnum?
Active, if set, contains the registration method that is being used. It is initially not set. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth link_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself. code_recovery CredentialsTypeRecoveryCode
no setter
expiresAt → DateTime
ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String
ID represents the flow's unique ID. When performing the registration flow, this represents the id in the registration ui's query parameter: http://<selfservice.flows.registration.ui_url>/?flow=
no setter
issuedAt → DateTime
IssuedAt is the time (UTC) when the flow occurred.
no setter
oauth2LoginChallenge → String?
Ory OAuth 2.0 Login Challenge. This value is set using the login_challenge query parameter of the registration and login endpoints. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.
no setter
oauth2LoginRequest → OAuth2LoginRequest?
no setter
organizationId → String?
no setter
requestUrl → String
RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example.
no setter
returnTo → String?
ReturnTo contains the requested return_to URL.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionTokenExchangeCode → String?
SessionTokenExchangeCode holds the secret code that the client can use to retrieve a session token after the flow has been completed. This is only set if the client has requested a session token exchange code, and if the flow is of type "api", and only on creating the flow.
no setter
state → JsonObject?
State represents the state of this request: choose_method: ask the user to choose a method (e.g. registration with email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the registration challenge was passed.
no setter
transientPayload → JsonObject?
TransientPayload is used to pass data from the registration to a webhook
no setter
type → String
The flow type can either be api or browser.
no setter
ui → UiContainer
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(RegistrationFlowBuilder)) → RegistrationFlow
Rebuilds the instance.
inherited
toBuilder() → RegistrationFlowBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<RegistrationFlow>
no setter