Skip to content

Product documentation

CoAdmin

The CoAdmin resource.

CoAdmin

The CoAdmin resource.

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

Operations

MethodPathSummaryScopes
POST/api/v1/member-invitations/acceptMember Invitation Accept Acceptbearer, no extra scope
GET/api/v1/membersCo Admin Listtenant:members.read
POST/api/v1/membersCo Admin Addtenant:members.write
GET/api/v1/members/invitationsCo Admin List Invitationstenant:members.read
DELETE/api/v1/members/invitations/{id}Co Admin Revoke Invitationtenant:members.write
POST/api/v1/members/inviteCo Admin Invitetenant:members.write
DELETE/api/v1/members/{subject}Co Admin Removetenant:members.write
PUT/api/v1/members/{subject}/environmentsCo Admin Set Environmentstenant: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/jsonAcceptMemberInvitationRequest

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)

GET /api/v1/members

Co Admin List

  • Operation ID: coAdminList
  • Required scopes: tenant:members.read

Responses:

StatusDescriptionBody
200OKCoAdminListResponse
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/members

Co Admin Add

  • Operation ID: coAdminAdd
  • Required scopes: tenant:members.write

Request body (required): application/jsonAddCoAdminRequest

Responses:

StatusDescriptionBody
201CreatedCoAdminResponse
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)

GET /api/v1/members/invitations

Co Admin List Invitations

  • Operation ID: coAdminListInvitations
  • Required scopes: tenant:members.read

Responses:

StatusDescriptionBody
200OKMemberInvitationListResponse
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/members/invitations/{id}

Co Admin Revoke Invitation

  • Operation ID: coAdminRevokeInvitation
  • Required scopes: tenant:members.write

Parameters:

NameInRequiredTypeDescription
idpathyesstring

Responses:

StatusDescriptionBody
204No Contentobject
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/members/invite

Co Admin Invite

  • Operation ID: coAdminInvite
  • Required scopes: tenant:members.write

Request body (required): application/jsonInviteCoAdminRequest

Responses:

StatusDescriptionBody
201CreatedInviteCoAdminResponse
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/members/{subject}

Co Admin Remove

  • Operation ID: coAdminRemove
  • Required scopes: tenant:members.write

Parameters:

NameInRequiredTypeDescription
subjectpathyesstring

Responses:

StatusDescriptionBody
204No Contentobject
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)

PUT /api/v1/members/{subject}/environments

Co Admin Set Environments

  • Operation ID: coAdminSetEnvironments
  • Required scopes: tenant:members.write

Parameters:

NameInRequiredTypeDescription
subjectpathyesstring

Request body (required): application/jsonSetCoAdminEnvironmentsRequest

Responses:

StatusDescriptionBody
200OKCoAdminResponse
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)