コンテンツにスキップ
Authrim

Redeem an Admin invitation code for Passkey enrollment.

POST
/api/admin/invitations/redeem
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/invitations/redeem \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "code": "example" }'

Validates the recipient email, one-time enrollment code, expiry, and optional source-IP restriction. This operation does not create an Admin account or session.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
email
required
string format: email
code
required
string
/^[23456789A-HJ-NP-Z]{4}(-[23456789A-HJ-NP-Z]{4}){3}$/
Example generated
{
  "email": "[email protected]",
  "code": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Short-lived Passkey enrollment credential and non-secret invitation summary.

Media type application/json
object
enrollment_token
required
string
expires_in
required
integer
Allowed value: 600
invitation
required
object
email
required
string format: email
name
string | null
role
required
string
ip_restriction_enabled
required
boolean
Example 
{
  "expires_in": 600
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}