Skip to content

Product documentation

DsarReturnEndpoint

The DsarReturnEndpoint resource.

DsarReturnEndpoint

The DsarReturnEndpoint resource.

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

Operations

MethodPathSummaryScopes
GET/api/v1/dsar-return-endpointsDsar Return Endpoint Listtenant:compliance.read
POST/api/v1/dsar-return-endpointsDsar Return Endpoint Registertenant:compliance.write
GET/api/v1/dsar-return-endpoints/{endpointId}Dsar Return Endpoint Gettenant:compliance.read
PATCH/api/v1/dsar-return-endpoints/{endpointId}Dsar Return Endpoint Toggletenant:compliance.write
DELETE/api/v1/dsar-return-endpoints/{endpointId}Dsar Return Endpoint Removetenant:compliance.write

Operation details

GET /api/v1/dsar-return-endpoints

Dsar Return Endpoint List

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

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/dsar-return-endpoints

Dsar Return Endpoint Register

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

Request body (required): application/jsonRegisterDsarReturnEndpointRequest

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/dsar-return-endpoints/{endpointId}

Dsar Return Endpoint Get

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

Parameters:

NameInRequiredTypeDescription
endpointIdpathyesstring

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)

PATCH /api/v1/dsar-return-endpoints/{endpointId}

Dsar Return Endpoint Toggle

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

Parameters:

NameInRequiredTypeDescription
endpointIdpathyesstring

Request body (required): application/jsonToggleDsarReturnEndpointRequest

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/dsar-return-endpoints/{endpointId}

Dsar Return Endpoint Remove

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

Parameters:

NameInRequiredTypeDescription
endpointIdpathyesstring

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)