Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Delete User

DELETE/api/v2/admin/users/{userId}

Delete the User with the specified id.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-write.

Path parameters

userId
string

A Foundry User ID.

Examples

Request

Copied!
1 2 3 curl -X DELETE \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/users/dd05feb8-662a-445d-8f4c-ce92d46bedeb"

Error responses

Error Name
DeleteUserPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not delete the User.
ParametersuserId
UserNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given User could not be found.
ParametersuserId