Delete the User with the specified id.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write
.
1
2
3
curl -X DELETE \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/admin/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb"
Error Name | ||
---|---|---|
Delete | Error Code | PERMISSION_DENIED |
Status Code | 403 | |
Description | Could not delete the User. | |
Parameters | userId | |
User | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | The given User could not be found. | |
Parameters | userId |
See Errors for a general overview of errors in the platform.