Delete a user profile

Deletes the specified user profile. Alternatively, you can use this endpoint to delete a child attribute of a plural attribute. In that case, only the child attribute is deleted; the rest of the user profile remains as-is.

❗️

Data removed with this API call is permanently deleted.

Refer to the Registration error codes page for details on error codes.

API client permissions

The following table indicates the API clients that can and can't be used to call this operation:

Authentication

This operation supports Basic authentication (recommended) as well as janrain-oauth and janrain-signed authentication. See Get started for more information.

Base URL

The base URL for this operation is your Identity Cloud Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Examples

Example: Delete a user record

This command deletes the user account with the uuid c1b6e517-9930-47dd-9fd5-d692053151ce. Note that deleting a user account is permanent: there's no way to restore a deleted account.

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg" \
  --data-urlencode type_name=user \
  --data-urlencode uuid=c1b6e517-9930-47dd-9fd5-d692053151c \
  https://my-app.janraincapture.com/entity.delete

Example response

If your API call succeeds the response consists of the status ok:

{
  "stat": "ok"
}

Example error response

If your API call doesn't succeed, you'll get back an error message similar to this:

{
  "argument_name": "uuid",
  "request_id": "9mq5bv72q47ehg7g",
  "code": 200,
  "error_description": "uuid was not valid for the following reason: invalid uuid",
  "error": "invalid_argument",
  "stat": "error"
}

See Registration error codes for more information about these error codes. Note that the Entity and Entity Type API doesn't use standard HTTP error codes.

Example: Delete a plural within a user record

❗️

Be careful when using a command similar to this: if you don't get the attribute name exactly right the endpoint ignores the plural and, instead, deletes the entire user record.

This command deletes a plural value from the user profile that has the uuid 30dd1406-f59a-4145-a6de-b94b5e8cacf3. In this example, the value 30721 is removed from the plural janrain.properties.managedBy.

curl -X POST \
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg" \
  --data-urlencode type_name=user \
  --data-urlencode uuid=30dd1406-f59a-4145-a6de-b94b5e8cacf3 \
  --data-urlencode attribute_name="janrain.properties.managedBy#30721" \
  https://my-app.janraincapture.com/entity.delete

Example response

If your API call succeeds the response consists of the word ok:

{
  "stat": "ok"
}

Query parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.