Sha256: cb9a2682f00f3144d4821f51959cec9dd4a73ef6cf95c8c9251aca366b43285c
Contents?: true
Size: 1.8 KB
Versions: 27
Compression:
Stored size: 1.8 KB
Contents
# OryClient::SettingsFlow ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **active** | **String** | Active, if set, contains the registration method that is being used. It is initially not set. | [optional] | | **continue_with** | [**Array<ContinueWith>**](ContinueWith.md) | Contains a list of actions, that could follow this flow It can, for example, contain a reference to the verification flow, created as part of the user's registration. | [optional] | | **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to update the setting, a new flow has to be initiated. | | | **id** | **String** | ID represents the flow's unique ID. When performing the settings flow, this represents the id in the settings ui's query parameter: http://<selfservice.flows.settings.ui_url>?flow=<id> | | | **identity** | [**Identity**](Identity.md) | | | | **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow occurred. | | | **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] | | **state** | [**SettingsFlowState**](SettingsFlowState.md) | | | | **type** | **String** | The flow type can either be `api` or `browser`. | | | **ui** | [**UiContainer**](UiContainer.md) | | | ## Example ```ruby require 'ory-client' instance = OryClient::SettingsFlow.new( active: null, continue_with: null, expires_at: null, id: null, identity: null, issued_at: null, request_url: null, return_to: null, state: null, type: null, ui: null ) ```
Version data entries
27 entries across 27 versions & 1 rubygems