SsfReceiver

The SsfReceiver resource.

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

Operations

Method	Path	Summary	Scopes
GET	/api/v1/ssf/receivers	Ssf Receiver List	tenant:compliance.read
POST	/api/v1/ssf/receivers	Ssf Receiver Register	tenant:compliance.write
GET	/api/v1/ssf/receivers/{receiverId}	Ssf Receiver Get	tenant:compliance.read
PATCH	/api/v1/ssf/receivers/{receiverId}	Ssf Receiver Toggle	tenant:compliance.write
DELETE	/api/v1/ssf/receivers/{receiverId}	Ssf Receiver Remove	tenant:compliance.write

Operation details

GET /api/v1/ssf/receivers

Ssf Receiver List

• Operation ID: ssfReceiverList
• Required scopes: tenant:compliance.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/ssf/receivers

Ssf Receiver Register

• Operation ID: ssfReceiverRegister
• Required scopes: tenant:compliance.write

Request body (required): application/json → RegisterSsfReceiverRequest

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/ssf/receivers/{receiverId}

Ssf Receiver Get

• Operation ID: ssfReceiverGet
• Required scopes: tenant:compliance.read

Parameters:

Name	In	Required	Type	Description
receiverId	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/ssf/receivers/{receiverId}

Ssf Receiver Toggle

• Operation ID: ssfReceiverToggle
• Required scopes: tenant:compliance.write

Parameters:

Name	In	Required	Type	Description
receiverId	path	yes	string

Request body (required): application/json → ToggleSsfReceiverRequest

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/ssf/receivers/{receiverId}

Ssf Receiver Remove

• Operation ID: ssfReceiverRemove
• Required scopes: tenant:compliance.write

Parameters:

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