test-cloud
latest
false
Test Cloud API guide
- Getting started
- Authentication
- Scopes and permissions
- Platform Management APIs
API endpoint for deleting a specific user from an organization based on the user ID in Test Cloud.
Deletes the specified user, based on the user ID.
API Endpoint
DELETE {accessURL}/{organizationName}/identity_/api/User/{userId}
Replace {accessURL} in all endpoint paths with the base URL for your cloud platform:
| Cloud platform | Access URL |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Public Sector | https://govcloud.uipath.us/ |
| Test Cloud Dedicated | https://{customURL}.dedicated.uipath.com/ |
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://cloud.uipath.com/{organizationName}/identity_ - 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://cloud.uipath.com/{organizationName}/identity_/api/User/66-ss' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
curl --location --request DELETE 'https://cloud.uipath.com/{organizationName}/identity_/api/User/66-ss' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'