compliance module route (requires compliance:erasure:admin)
POST
/v1/m/compliance/data-subjects/{id}/erase
const url = 'https://example.com/v1/m/compliance/data-subjects/example/erase';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"aliases":["example"],"case_ref":"example","data_classes":["example"],"provider_user_ids":["example"],"reason":"example","subject_kind":"user"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/m/compliance/data-subjects/example/erase \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "aliases": [ "example" ], "case_ref": "example", "data_classes": [ "example" ], "provider_user_ids": [ "example" ], "reason": "example", "subject_kind": "user" }'Opens an erasure request for one data subject, optionally narrowed by subject kind and tied to a case reference.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Path parameter id.
Header Parameters
Section titled “Header Parameters ” X-Olivares-Tenant
string format: uuid
Target tenant id; required when the principal can act in more than one tenant.
Request Body
Section titled “Request Body ” Media type application/json
object
aliases
Array<string>
case_ref
string
data_classes
Array<string>
provider_user_ids
Array<string>
reason
string
subject_kind
string
Responses
Section titled “ Responses ”OK
Media type application/json
object
Example generated
{}Bad request
Media type application/json
object
Example generated
{}Unauthenticated
Media type application/json
object
Example generated
{}Forbidden
Media type application/json
object
Example generated
{}Not found
Media type application/json
object
Example generated
{}Conflict / setup required
Media type application/json
object
Example generated
{}Rate limited
Media type application/json
object
Example generated
{}