Remove Users From Organization By Organization Id Using DELETE

Remove Users From Organization By Organization Id Using DELETE

Remove users from organization by user ids.
User ids will be of the format : e.g. vmware.com:820e7ca5-4024-407e-8db4-f552d5d03403.
Pay attention: in case of partial success the caller must read the response to see which users have not been added successfully

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
DELETE
https://{api_host}/csp/gateway/am/api/v2/orgs/{orgId}/users
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Request Body
RemoveUsersFromOrganizationRequestV2 of type(s) application/json
Required

Show optional properties

{
    "ids": [
        {}
    ]
}
{
    "ids": [
        "string"
    ],
    "notifyUsers": false
}
array of string
ids
Required
Constraints: minItems: 0 maxItems: 20

Identifiers of the users that will be removed from the organization.

boolean
notifyUsers
Optional
Constraints: default: true

Send e-mail notification to the user(s).

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PartialSuccessResponseString of type(s) application/json 
"PartialSuccessResponseString Object"
array of string
failed
Optional

The entities for which the operation failed.

array of string
succeeded
Optional

The entities for which the operation is successful.


400

Cannot remove more than 20 users at the same time | Cannot remove the last org owner

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


404

Organization with this identifier is not found. | Users [...] not found

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
errorCode
Optional

errorCode

string
message
Optional

message

integer As int32 As int32
moduleCode
Optional

moduleCode

string
requestId
Optional

requestId

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"ids":["string"]}' https://{api_host}/csp/gateway/am/api/v2/orgs/{orgId}/users
On This Page
Organization Operations
GET
Get Organization By Id Using GET
PATCH
Update Organization By Organization Id Using PATCH
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
GET
Get Organization Clients By Organization Id Using GET
POST
Assign Roles To Clients On Organization Using POST
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Org Linked Idp Details Using GET
POST
Link Org To Idp Using POST
GET
Get Organization Invitations By Organization Id Using GET
POST
Invite Users Using POST
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
GET
Get Organization Roles By Organization Id Using GET
GET
Get Sub Organizations By Organization Id Using GET
POST
Activate Organization Refresh Tokens Using POST
Deprecated
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
DELETE
Remove Users From Organization By Organization Id Using DELETE
GET
Get Organization Users By Organization Id Using GET