[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Delete Org Users

Description

Removes users from your organization and revokes their access.

Request

Request

URL

URL


delete
https://{api_host}/v1/orgs/{orgId}/users
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

context can be OPERATOR, PROVIDER or TENANT


Request Body

Request Body

Users of mimetype application/json Optional
{
	"users": [
		{
			"idpId": "string",
			"username": "string"
		}
	]
}
array of ExtendedUsername
users Optional

The list of users.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns GenericUserResponse of type application/json
{
	"status": {
		"failed": {
			"key": "string"
		},
		"succeeded": [
			"string"
		]
	}
}
status Optional

Defines the properties of the partial success response.

Errors

Errors

401

Unauthorized - The user is not authorized to use the API


403

Forbidden - User does not have permission for this operation


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X DELETE -H "Content-Type: application/json" -d '{"users":[{"idpId":"string","username":"string"}]}' https://{api_host}/v1/orgs/{orgId}/users


Feedback

Was this page helpful?