Skip to content

Product documentation

Guest

Guest invitations: invite, redeem, revoke, list.

Guest

Guest invitations: invite, redeem, revoke, list.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/guestsGuest List Gueststenant:guests.manage
POST/api/v1/guests/inviteGuest Invite Guesttenant:guests.invite
POST/api/v1/guests/redeemGuest Redeem Invitationbearer, no extra scope
DELETE/api/v1/guests/{id}Guest Revoke Invitationtenant:guests.manage

Operation details

GET /api/v1/guests

Guest List Guests

  • Operation ID: guestListGuests
  • Required scopes: tenant:guests.manage

Parameters:

NameInRequiredTypeDescription
limitquerynointeger
cursorquerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonInviteRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonRedeemRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)