Delete user PII

DELETE

/api/admin/users/{id}/pii

Code sample: Shell / cURL

curl --request DELETE \
  --url https://auth.example.com/api/admin/users/example/pii \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "user_request", "retention_days": 90 }'

Deletes only the user PII values, creates a tombstone, and leaves the account active.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Request Body

JSON request body.

Media type application/json

object

reason

string

retention_days

integer

key

additional properties

Example

{
  "reason": "user_request",
  "retention_days": 90
}

Responses

200

Successful JSON response.

Media type application/json

object

success

required

boolean

message

required

string

user_id

required

string

pii_status

required

string

tombstone_created

required

boolean

retention_days

required

integer

key

additional properties

Example

{
  "success": true,
  "message": "User PII deleted successfully. User account remains active.",
  "user_id": "user_123",
  "pii_status": "deleted",
  "tombstone_created": true,
  "retention_days": 90
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}