ORory
identity

Create a Recovery Link

Changed on

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

post/admin/recovery/link

Request

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

Query parameters

return_tostring

Request body

expires_instring

Link Expires In

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

identity_idstring uuid required

Identity to Recover

The identity's ID you wish to recover.

Response

recoveryLinkForIdentity

expires_atstring date-time

Recovery Link Expires At

The timestamp when the recovery link expires.

recovery_linkstring required

Recovery Link

This link can be used to recover the account.

Example response

{
  "expires_at": "2000-01-23T04:56:07.000+00:00",
  "recovery_link": "recovery_link"
}

Changes