LoginFlow class abstract

This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client. Once a login flow is completed successfully, a session cookie or session token will be issued.

Properties:

  • active - The active login method If set contains the login method used. If the flow is new, it is unset. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML 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
  • createdAt - CreatedAt is a helper struct field for gobuffalo.pop.
  • 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 login flow, this represents the id in the login UI's query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id>
  • issuedAt - IssuedAt is the time (UTC) when the flow started.
  • 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
  • refresh - Refresh stores whether this login flow should enforce re-authentication.
  • 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.
  • requestedAal
  • 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 login 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 login flow.
  • state - State represents the state of this request: choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed.
  • transientPayload - TransientPayload is used to pass data from the login to hooks and email templates
  • type - The flow type can either be api or browser.
  • ui
  • updatedAt - UpdatedAt is a helper struct field for gobuffalo.pop.
Annotations
  • @BuiltValue()

Constructors

LoginFlow.new([void updates(LoginFlowBuilder b)])
factory

Properties

active → LoginFlowActiveEnum?
The active login method If set contains the login method used. If the flow is new, it is unset. password CredentialsTypePassword oidc CredentialsTypeOIDC totp CredentialsTypeTOTP lookup_secret CredentialsTypeLookup webauthn CredentialsTypeWebAuthn code CredentialsTypeCodeAuth passkey CredentialsTypePasskey profile CredentialsTypeProfile saml CredentialsTypeSAML 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
createdAt → DateTime?
CreatedAt is a helper struct field for gobuffalo.pop.
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 login flow, this represents the id in the login UI's query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id>
no setter
issuedAt → DateTime
IssuedAt is the time (UTC) when the flow started.
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
refresh → bool?
Refresh stores whether this login flow should enforce re-authentication.
no setter
requestedAal → AuthenticatorAssuranceLevel?
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 login 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 login flow.
no setter
state → JsonObject?
State represents the state of this request: choose_method: ask the user to choose a method to sign in with sent_email: the email has been sent to the user passed_challenge: the request was successful and the login challenge was passed.
no setter
transientPayload → JsonObject?
TransientPayload is used to pass data from the login to hooks and email templates
no setter
type → String
The flow type can either be api or browser.
no setter
ui → UiContainer
no setter
updatedAt → DateTime?
UpdatedAt is a helper struct field for gobuffalo.pop.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(LoginFlowBuilder)) → LoginFlow
Rebuilds the instance.
inherited
toBuilder() → LoginFlowBuilder
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<LoginFlow>
no setter