ORory
identity

Create a Recovery Code

This endpoint creates a recovery code which should be given to the user in order for them to recover (or activate) their account.

post/admin/recovery/code

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/recovery/code
  • Auth
    API key in header Authorization

Request body

expires_instring

Code Expires In

The recovery code will expire after that amount of time has passed. Defaults to the configuration value of selfservice.methods.code.config.lifespan.

flow_typestring

The flow type can either be api or browser.

identity_idstring uuid required

Identity to Recover

The identity's ID you wish to recover.

Response

recoveryCodeForIdentity

expires_atstring date-time

Expires At is the timestamp of when the recovery flow expires

The timestamp when the recovery code expires.

recovery_codestring required

RecoveryCode is the code that can be used to recover the account

recovery_linkstring required

RecoveryLink with flow

This link opens the recovery UI with an empty code field.

Changes

No recorded changes to this operation across all 65 revisions of this API.