Delete password

The endpoint provides functionality to delete a password for an existing user.

HTTP request

DELETE https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/password

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
userId	path	string	required	The ID of the user

Example request

Set the ID of the user.

userId=your-user-id-123

curl --request DELETE "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId/password" \
  --header "Authorization: Bearer $accessKey"

HTTP response

On success

HTTP/1.1 204 is returned if the password is successfully deleted.

On missing credential

HTTP/1.1 404 is returned if no user is found with the given userId or user has no password, with a detailed message.

Example response

note

The referred extId field in the response equals the userId.

User is not found

{
    "errors": [
        {
            "code": "errors.noRecord",
            "message": "A user with extId 4a5e7346-488b-46f9-914f-79ddb1131e0ba doesn't exist on client with name Client-users"
        }
    ]
}

User has no password credential

{
    "errors": [
        {
            "code": "errors.noRecord",
            "message": "User with extId 4a5e7346-488b-46f9-914f-79ddb1131e0ba has no Password credential"
        }
    ]
}

On failure

HTTP/1.1 401 is returned if the authorization fails due to an invalid access key.

HTTP/1.1 500 is returned if an unexpected error occurs.