Product documentation
DsarReturnEndpoint
The DsarReturnEndpoint resource.
DsarReturnEndpoint
The DsarReturnEndpoint resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/dsar-return-endpoints | Dsar Return Endpoint List | tenant:compliance.read |
POST | /api/v1/dsar-return-endpoints | Dsar Return Endpoint Register | tenant:compliance.write |
GET | /api/v1/dsar-return-endpoints/{endpointId} | Dsar Return Endpoint Get | tenant:compliance.read |
PATCH | /api/v1/dsar-return-endpoints/{endpointId} | Dsar Return Endpoint Toggle | tenant:compliance.write |
DELETE | /api/v1/dsar-return-endpoints/{endpointId} | Dsar Return Endpoint Remove | tenant:compliance.write |
Operation details
GET /api/v1/dsar-return-endpoints
Dsar Return Endpoint List
- Operation ID:
dsarReturnEndpointList - 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/dsar-return-endpoints
Dsar Return Endpoint Register
- Operation ID:
dsarReturnEndpointRegister - Required scopes:
tenant:compliance.write
Request body (required): application/json → RegisterDsarReturnEndpointRequest
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/dsar-return-endpoints/{endpointId}
Dsar Return Endpoint Get
- Operation ID:
dsarReturnEndpointGet - Required scopes:
tenant:compliance.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
endpointId | 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/dsar-return-endpoints/{endpointId}
Dsar Return Endpoint Toggle
- Operation ID:
dsarReturnEndpointToggle - Required scopes:
tenant:compliance.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
endpointId | path | yes | string |
Request body (required): application/json → ToggleDsarReturnEndpointRequest
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/dsar-return-endpoints/{endpointId}
Dsar Return Endpoint Remove
- Operation ID:
dsarReturnEndpointRemove - Required scopes:
tenant:compliance.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
endpointId | 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) |