Sha256: 354d6a6469d05475fdb5894d9216c4ed0aefff1bab597e9ec804ec041d35e41d

Contents?: true

Size: 1.53 KB

Versions: 25

Compression:

Stored size: 1.53 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] |
| **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,
  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

25 entries across 25 versions & 1 rubygems

Version Path
ory-client-1.1.23 docs/SettingsFlow.md
ory-client-1.1.22 docs/SettingsFlow.md
ory-client-1.1.21 docs/SettingsFlow.md
ory-client-1.1.20 docs/SettingsFlow.md
ory-client-1.1.19 docs/SettingsFlow.md
ory-client-1.1.18 docs/SettingsFlow.md
ory-client-1.1.17 docs/SettingsFlow.md
ory-client-1.1.16 docs/SettingsFlow.md
ory-client-1.1.15 docs/SettingsFlow.md
ory-client-1.1.14 docs/SettingsFlow.md
ory-client-1.1.13 docs/SettingsFlow.md
ory-client-1.1.12 docs/SettingsFlow.md
ory-client-1.1.11 docs/SettingsFlow.md
ory-client-1.1.10 docs/SettingsFlow.md
ory-client-1.1.7 docs/SettingsFlow.md
ory-client-1.1.5 docs/SettingsFlow.md
ory-client-1.1.4 docs/SettingsFlow.md
ory-client-1.1.3 docs/SettingsFlow.md
ory-client-1.1.2 docs/SettingsFlow.md
ory-client-1.1.1 docs/SettingsFlow.md