API Docs
Delete user
Contents
This Web service deletes a specific user.
Resource URL
DELETE /almaws/v1/users/{user_id}
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
user_id_type | xs:string | Optional. Default: all_unique | The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. |
Body Parameters
None
Output
This method returns HTTP 204 (No Content) which means that the server successfully processed the request, but is not returning any content.
Possible Error Codes
Code | Message |
---|---|
401890 | User with identifier X of type Y was not found. |
401850 | Failed to delete user with identifier X of type Y. |