Product documentation
Guest
Guest invitations: invite, redeem, revoke, list.
Guest
Guest invitations: invite, redeem, revoke, list.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/guests | Guest List Guests | tenant:guests.manage |
POST | /api/v1/guests/invite | Guest Invite Guest | tenant:guests.invite |
POST | /api/v1/guests/redeem | Guest Redeem Invitation | bearer, no extra scope |
DELETE | /api/v1/guests/{id} | Guest Revoke Invitation | tenant:guests.manage |
Operation details
GET /api/v1/guests
Guest List Guests
- Operation ID:
guestListGuests - Required scopes:
tenant:guests.manage
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/guests/invite
Guest Invite Guest
- Operation ID:
guestInviteGuest - Required scopes:
tenant:guests.invite
Request body (required): application/json → InviteRequest
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/guests/redeem
Guest Redeem Invitation
- Operation ID:
guestRedeemInvitation - Required scopes: bearer, no extra scope
Request body (required): application/json → RedeemRequest
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/guests/{id}
Guest Revoke Invitation
- Operation ID:
guestRevokeInvitation - Required scopes:
tenant:guests.manage
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | 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) |