orchestrator
2024.10
false
- Getting started
- Authentication
- Swagger definition
- Orchestrator APIs
- Alerts Requests
- Assets requests
- Calendars requests
- Environments requests
- Folders requests
- Generic Tasks requests
- Jobs requests
- Libraries requests
- License requests
- Packages requests
- Permissions requests
- Personal workspaces requests
- Processes requests
- Queue Items requests
- Queue retention policy requests
- Robots requests
- Roles requests
- Schedules requests
- Settings requests
- Storage bucket requests
- Tasks requests
- Task Catalogs requests
- Task Forms requests
- Tenants requests
- Transactions requests
- Users requests
- Webhooks requests
- Platform Management APIs
- Update User
- Delete Specific User
- Delete Users
Orchestrator API guide
Last updated Mar 24, 2026
Delete Specific User
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 here.
Path Parameters
| Path param | Data type | Description |
|---|---|---|
userId (required) | String | 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 look like below (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'