Skip to content

Product documentation

ErasureRequest

The ErasureRequest resource.

ErasureRequest

The ErasureRequest resource.

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

Operations

MethodPathSummaryScopes
POST/api/v1/erasure-requestsErasure Request Createtenant:compliance.write
GET/api/v1/erasure-requests/{requestId}Erasure Request Statustenant:compliance.read
POST/api/v1/erasure-requests/{requestId}/holdsErasure Request Raise Holdtenant:compliance.write
DELETE/api/v1/erasure-requests/{requestId}/holds/{holdId}Erasure Request Lift Holdtenant:compliance.write

Operation details

POST /api/v1/erasure-requests

Erasure Request Create

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

Parameters:

NameInRequiredTypeDescription
Idempotency-Keyheadernostring

Request body (required): application/jsonCreateErasureRequest

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/erasure-requests/{requestId}

Erasure Request Status

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

Parameters:

NameInRequiredTypeDescription
requestIdpathyesstring

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/erasure-requests/{requestId}/holds

Erasure Request Raise Hold

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

Parameters:

NameInRequiredTypeDescription
requestIdpathyesstring

Request body (required): application/jsonRaiseHoldRequest

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/erasure-requests/{requestId}/holds/{holdId}

Erasure Request Lift Hold

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

Parameters:

NameInRequiredTypeDescription
requestIdpathyesstring
holdIdpathyesstring

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)