docs/RegistrationFlow

OryClient::RegistrationFlow

Properties

Name Type Description Notes
active IdentityCredentialsType [optional]
expires_at Time 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 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=<id>
issued_at Time IssuedAt is the time (UTC) when the flow occurred.
oauth2_login_challenge String [optional]
oauth2_login_request OAuth2LoginRequest [optional]
request_url 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.
return_to String ReturnTo contains the requested return_to URL. [optional]
session_token_exchange_code 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. [optional]
transient_payload Object TransientPayload is used to pass data from the registration to a webhook [optional]
type String The flow type can either be api or browser.
ui UiContainer

Example

require 'ory-client'

instance = OryClient::RegistrationFlow.new(
  active: null,
  expires_at: null,
  id: null,
  issued_at: null,
  oauth2_login_challenge: null,
  oauth2_login_request: null,
  request_url: null,
  return_to: null,
  session_token_exchange_code: null,
  transient_payload: null,
  type: null,
  ui: null
)