This API has a deprecated equivalent from v7.0U1.
Remove Management Administrators
DescriptionRemove the group from the local sso group. Usage beyond VMware Cloud on AWS is not supported.
Request
URLURL
https://{api_host}/api/hvc/management/administrators?action=remove
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
HvcManagementAdministratorsRemoveRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"group_name": "string"
}
string
group_name
Required
Name of the group to be removed. Ex - xyz@abc.com where xyz is the group name and abc.com is the domain name
Authentication
This operation uses the following authentication methods.
Errors
Errors
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$HvcManagementAdministratorsRemoveRequestBody = Initialize-HvcManagementAdministratorsRemoveRequestBody -GroupName "MyGroupName"
Invoke-RemoveManagementAdministrators -HvcManagementAdministratorsRemoveRequestBody $HvcManagementAdministratorsRemoveRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"group_name":"string"}' https://{api_host}/api/hvc/management/administrators?action=remove
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/hvc/management/administrators?action=remove
x-vmw-doc-operation: remove
Availability
Added in 7.0U2
