Ctrl+K

Get Recovery Codes

get/api/v2/user/recoverycodes/{recoveryCodeSetId}

Get the recovery codes for the given recovery code set ID. Requires the user_manage scope. Session must be unlocked using the Unlock endpoint, prior to hitting this route.

Path Parameters

  • recoveryCodeSetIdstringRequired
    The ID of the recovery code set
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

200 Response

id string required
Example: 59cd72485007a239fb00282ed480da1f
Match pattern: ^[0-9a-f]{32}$
created string <date-time>required
ISO 8601 string representation of date
Example: 2019-05-02T15:27:35.773Z
codes array[object] required
Min items: >= 10 items
Max items: <= 10 items
code string required
The recovery code
Example: uFN4wrsjdpK3
isActive boolean required
Whether the recovery code is active
Example: true

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

404 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id