Skip to main content

Deletes an existing User.

DELETE 
/Users/:userId

The endpoint used to delete a User resource. This is not reversible.

Request​

Path Parameters

    userId stringrequired

    The id of User resource. If lookupByName is set to true, this path parameter should be set to the userName of the User.

Query Parameters

    lookupByName boolean

    A boolean value that determines if the User resource will be looked up by userName instead of userId (value in path parameter 'userId'). Setting this query parameter to true will cause the value pulled from the 'userId' path parameter to be treated as a userName when searching for the resource.

    Example: scim/v2/Users/Mock.User?lookupByName=true

Responses​

Returns a 204 with no response body if delete was successful.

Loading...