コンテンツにスキップ
Authrim

Verify the new Passkey and atomically activate the Admin account.

POST
/api/admin/invitations/activate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/invitations/activate \
  --header 'Content-Type: application/json' \
  --data '{ "enrollment_token": "example", "challenge_id": "example", "credential": { "additionalProperty": "example" } }'

Verifies possession of the Passkey registered in the same enrollment and atomically creates the Admin user, Passkey, role assignment, and Admin session while consuming the invitation.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
enrollment_token
required
string
challenge_id
required
string
credential
required
object
key
additional properties
Example generated
{
  "enrollment_token": "example",
  "challenge_id": "example",
  "credential": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin account activated and Admin session cookie set.

Media type application/json
object
success
required
boolean
user
required
object
id
required
string
email
required
string format: email
name
string
role
required
string
Example 
{
  "success": true
}

Headers

Section titled “Headers ”
Set-Cookie
string

400

Section titled “400 ”

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
  }
}

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
  }
}

409

Section titled “409 ”

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
  }
}