Invitations
Operations of the Identity API (public). Paths are relative to your deployment's API host.
GET /api/identity-api/invitations/{code}
GET :code (organizations)
Reads an invitation by its code. PUBLIC — no authentication. Because this deployment serves multiple realms and an unauthenticated request carries no tenant signal, the realm query parameter is REQUIRED and must name a realm this deployment serves; the invitation is looked up within that realm only. Omitted, blank or unserved values are rejected with 400, and a code belonging to another realm returns 404.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
code | path | string | yes | |
realm | query | string | yes | Realm the invitation belongs to. Required — this endpoint is unauthenticated and has no other way to identify the tenant. |
| Status | Description | Body |
|---|---|---|
| 200 | Get invitation details by code | application/json object |
| 400 | Bad Request | application/json object |
| 404 | Not Found | application/json object |
POST /api/identity-api/invitations/{code}/accept
POST :code/accept (organizations)
Executes accept invitation for organizations within the authenticated request context. Validate request DTO constraints and return the documented response contract.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
code | path | string | yes |
| Status | Description | Body |
|---|---|---|
| 200 | Accept invitation and join organization | application/json object |
| 400 | Bad Request | application/json object |
| 401 | Unauthorized | application/json object |
| 403 | Forbidden | application/json object |
| 404 | Not Found | application/json object |
| 409 | Conflict | application/json object |