Consume an invitation after signup.

POST

/api/v1/invitations/use

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/v1/invitations/use \
  --header 'Content-Type: application/json' \
  --data '{ "token": "invite_123", "user_id": "user_123" }'

Marks an invitation token as used for a verified user in the invited tenant and applies configured role or organization assignments.

Request Body ^required

Media type application/json

object

token

required

string

user_id

required

string

Example

{
  "token": "invite_123",
  "user_id": "user_123"
}

Responses

200

Successful JSON response.

Media type application/json

object

success

required

boolean

invitation_id

string

tenant_id

string

role_assigned

boolean

organization_assigned

boolean

Example

{
  "success": true,
  "invitation_id": "inv_123",
  "tenant_id": "tenant_123",
  "role_assigned": true,
  "organization_assigned": false
}

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

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

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