Skip to main content

Delete an identity

Soft-delete an identity.

Request headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Path parameters

ParameterTypeRequiredDescription
identity_idstringYesID of the identity to delete.

Example request

curl -s -X DELETE 'https://api.qoder.com.cn/api/v1/forward/identities/idn_019eabc123' \
  -H "Authorization: Bearer $QODER_PAT"

Example response

HTTP 200 OK
{
  "id": "idn_019eabc123",
  "deleted": true
}

Response body

FieldTypeDescription
idstringID of the deleted identity.
deletedbooleanWhether the identity is marked as deleted.

Response codes

HTTPTypeTrigger
404not_found_errorThe identity doesn't exist or isn't visible to the caller.
409conflict_errorThe identity can't be deleted in its current state.
401authentication_errorThe PAT is invalid or expired.

Notes

  • A deleted identity can't be used to create new sessions.
  • Deletion is soft; historical records are preserved.