Automation Suite - Delete specific user

automation-suite

2024.10

false

Automation Suite API guide

Delete specific user

API endpoint for deleting a specific local user from an organization in Automation Suite, based on user ID.

Deletes the specified user, based on the local user ID.

API endpoint

DELETE https://{yourDomain}/{organizationName}/identity_/api/User/{userId}

Scopes

Requires the following scopes:

PM.User
PM.User.Write

Request headers

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Note:

To obtain the {access_token}, make sure to authenticate through one of the methods described in Authentication methods.

Path parameters

Parameter	Data type	Description
`userId`	String	Required. The ID of the user you want to delete.

Responses

204 Success

The indicated user is deleted from the organization.

Example request

Let's say you gathered all the information needed to build the API call.

Your {baseURL} is: https://{yourDomain}/{organizationName}/{tenantName}/
Your {access_token} is: 1234 (for length considerations).
The user ID you want to delete is 66-ss

The call should resemble the following example (cURL):

curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/66-ss' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request DELETE 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/66-ss' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

On this page

API endpoint
Scopes
Request headers
Path parameters
Responses
204 Success
Example request

Was this page helpful?

PREVIOUSUpdate user

NEXTDelete users

API endpoint​

Scopes​

Request headers​

Path parameters​

Responses​

204 Success​

Example request​