Sha256: d636c812712601c4ff1c7331f65888c91cb709140fde91ea13e4b0a3edd02c68

Contents?: true

Size: 1.7 KB

Versions: 8

Compression:

Stored size: 1.7 KB

Contents

# OryClient::RegistrationFlow

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [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**](OAuth2LoginRequest.md) |  | [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] |
| **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**](UiContainer.md) |  |  |

## Example

```ruby
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,
  transient_payload: null,
  type: null,
  ui: null
)
```

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
ory-client-1.1.25 docs/RegistrationFlow.md
ory-client-1.1.24 docs/RegistrationFlow.md
ory-client-1.1.23 docs/RegistrationFlow.md
ory-client-1.1.22 docs/RegistrationFlow.md
ory-client-1.1.21 docs/RegistrationFlow.md
ory-client-1.1.20 docs/RegistrationFlow.md
ory-client-1.1.19 docs/RegistrationFlow.md
ory-client-1.1.18 docs/RegistrationFlow.md