Product documentation
ErasureRequest
The ErasureRequest resource.
ErasureRequest
The ErasureRequest resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
POST | /api/v1/erasure-requests | Erasure Request Create | tenant:compliance.write |
GET | /api/v1/erasure-requests/{requestId} | Erasure Request Status | tenant:compliance.read |
POST | /api/v1/erasure-requests/{requestId}/holds | Erasure Request Raise Hold | tenant:compliance.write |
DELETE | /api/v1/erasure-requests/{requestId}/holds/{holdId} | Erasure Request Lift Hold | tenant:compliance.write |
Operation details
POST /api/v1/erasure-requests
Erasure Request Create
- Operation ID:
erasureRequestCreate - Required scopes:
tenant:compliance.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
Idempotency-Key | header | no | string |
Request body (required): application/json → CreateErasureRequest
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/erasure-requests/{requestId}
Erasure Request Status
- Operation ID:
erasureRequestStatus - Required scopes:
tenant:compliance.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
requestId | 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) |
POST /api/v1/erasure-requests/{requestId}/holds
Erasure Request Raise Hold
- Operation ID:
erasureRequestRaiseHold - Required scopes:
tenant:compliance.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
requestId | path | yes | string |
Request body (required): application/json → RaiseHoldRequest
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/erasure-requests/{requestId}/holds/{holdId}
Erasure Request Lift Hold
- Operation ID:
erasureRequestLiftHold - Required scopes:
tenant:compliance.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
requestId | path | yes | string | |
holdId | 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) |