FederationMembers

The FederationMembers resource.

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

Operations

Method	Path	Summary	Scopes
GET	/api/v1/federation-members	Federation Members List	tenant:federation.read
POST	/api/v1/federation-members	Federation Members Create	tenant:federation.write
GET	/api/v1/federation-members/{memberId}	Federation Members Get	tenant:federation.read
PATCH	/api/v1/federation-members/{memberId}	Federation Members Update	tenant:federation.write
DELETE	/api/v1/federation-members/{memberId}	Federation Members Delete	tenant:federation.write

Operation details

GET /api/v1/federation-members

Federation Members List

• Operation ID: federationMembersList
• Required scopes: tenant:federation.read

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/federation-members

Federation Members Create

• Operation ID: federationMembersCreate
• Required scopes: tenant:federation.write

Request body: application/json → CreateFederationMemberRequest

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/federation-members/{memberId}

Federation Members Get

• Operation ID: federationMembersGet
• Required scopes: tenant:federation.read

Parameters:

Name	In	Required	Type	Description
memberId	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)

PATCH /api/v1/federation-members/{memberId}

Federation Members Update

• Operation ID: federationMembersUpdate
• Required scopes: tenant:federation.write

Parameters:

Name	In	Required	Type	Description
memberId	path	yes	string

Request body: application/json → UpdateFederationMemberRequest

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/federation-members/{memberId}

Federation Members Delete

• Operation ID: federationMembersDelete
• Required scopes: tenant:federation.write

Parameters:

Name	In	Required	Type	Description
memberId	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)