Product documentation
CoAdmin
The CoAdmin resource.
CoAdmin
The CoAdmin resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
POST | /api/v1/member-invitations/accept | Member Invitation Accept Accept | bearer, no extra scope |
GET | /api/v1/members | Co Admin List | tenant:members.read |
POST | /api/v1/members | Co Admin Add | tenant:members.write |
GET | /api/v1/members/invitations | Co Admin List Invitations | tenant:members.read |
DELETE | /api/v1/members/invitations/{id} | Co Admin Revoke Invitation | tenant:members.write |
POST | /api/v1/members/invite | Co Admin Invite | tenant:members.write |
DELETE | /api/v1/members/{subject} | Co Admin Remove | tenant:members.write |
PUT | /api/v1/members/{subject}/environments | Co Admin Set Environments | tenant:members.write |
Operation details
POST /api/v1/member-invitations/accept
Member Invitation Accept Accept
- Operation ID:
memberInvitationAcceptAccept - Required scopes: bearer, no extra scope
Request body (required): application/json → AcceptMemberInvitationRequest
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) |
GET /api/v1/members
Co Admin List
- Operation ID:
coAdminList - Required scopes:
tenant:members.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | CoAdminListResponse |
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/members
Co Admin Add
- Operation ID:
coAdminAdd - Required scopes:
tenant:members.write
Request body (required): application/json → AddCoAdminRequest
Responses:
| Status | Description | Body |
|---|---|---|
201 | Created | CoAdminResponse |
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) |
GET /api/v1/members/invitations
Co Admin List Invitations
- Operation ID:
coAdminListInvitations - Required scopes:
tenant:members.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | MemberInvitationListResponse |
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/members/invitations/{id}
Co Admin Revoke Invitation
- Operation ID:
coAdminRevokeInvitation - Required scopes:
tenant:members.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
204 | No Content | 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/members/invite
Co Admin Invite
- Operation ID:
coAdminInvite - Required scopes:
tenant:members.write
Request body (required): application/json → InviteCoAdminRequest
Responses:
| Status | Description | Body |
|---|---|---|
201 | Created | InviteCoAdminResponse |
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/members/{subject}
Co Admin Remove
- Operation ID:
coAdminRemove - Required scopes:
tenant:members.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
subject | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
204 | No Content | 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) |
PUT /api/v1/members/{subject}/environments
Co Admin Set Environments
- Operation ID:
coAdminSetEnvironments - Required scopes:
tenant:members.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
subject | path | yes | string |
Request body (required): application/json → SetCoAdminEnvironmentsRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | CoAdminResponse |
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) |