Sha256: d4a01e8948c300d36aa2cfe8c84757caede3a4b0b46a37023ef6d0c13851a587

Contents?: true

Size: 1.42 KB

Versions: 33

Compression:

Stored size: 1.42 KB

Contents

# OryClient::UpdateRecoveryFlowWithCodeMethod

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **code** | **String** | Code from the recovery email  If you want to submit a code, use this field, but make sure to _not_ include the email field, as well. | [optional] |
| **csrf_token** | **String** | Sending the anti-csrf token is only required for browser login flows. | [optional] |
| **email** | **String** | The email address of the account to recover  If the email belongs to a valid account, a recovery email will be sent.  If you want to notify the email address if the account does not exist, see the [notify_unknown_recipients flag](https://www.ory.sh/docs/kratos/self-service/flows/account-recovery-password-reset#attempted-recovery-notifications)  If a code was already sent, including this field in the payload will invalidate the sent code and re-send a new code.  format: email | [optional] |
| **method** | **String** | Method is the method that should be used for this recovery flow  Allowed values are `link` and `code`. link RecoveryStrategyLink code RecoveryStrategyCode |  |
| **transient_payload** | **Object** | Transient data to pass along to any webhooks | [optional] |

## Example

```ruby
require 'ory-client'

instance = OryClient::UpdateRecoveryFlowWithCodeMethod.new(
  code: null,
  csrf_token: null,
  email: null,
  method: null,
  transient_payload: null
)
```

Version data entries

33 entries across 33 versions & 1 rubygems

Version Path
ory-client-1.14.1 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.14.0 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.10 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.6 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.4 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.3 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.2 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.1 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.13.0 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.11.6 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.9.0 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.8.1 docs/UpdateRecoveryFlowWithCodeMethod.md
ory-client-1.8.0 docs/UpdateRecoveryFlowWithCodeMethod.md