Product documentation
Invitations
The Invitations resource.
Invitations
The Invitations resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/invitations | Invitations List | tenant:users.read |
POST | /api/v1/invitations | Invitations Create | tenant:users.write |
DELETE | /api/v1/invitations/{invitationId} | Invitations Revoke | tenant:users.write |
POST | /api/v1/invitations/{invitationId}/resend | Invitations Resend | tenant:users.write |
Operation details
GET /api/v1/invitations
Invitations List
- Operation ID:
invitationsList - Required scopes:
tenant:users.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
limit | query | no | integer | |
cursor | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/invitations
Invitations Create
- Operation ID:
invitationsCreate - Required scopes:
tenant:users.write
Request body (required): application/json → CreateInvitationRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/invitations/{invitationId}
Invitations Revoke
- Operation ID:
invitationsRevoke - Required scopes:
tenant:users.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
invitationId | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/invitations/{invitationId}/resend
Invitations Resend
- Operation ID:
invitationsResend - Required scopes:
tenant:users.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
invitationId | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |