This API has a deprecated equivalent from v7.0U1.
Set Management Administrators
DescriptionSets the groups in the local sso group. Usage beyond VMware Cloud on AWS is not supported.
Request
URLURL
https://{api_host}/api/hvc/management/administrators
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
HvcManagementAdministratorsSetRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"group_names": [
"string"
]
}
array of
string
group_names
Required
Names the groups to be in the CloudAdminGroup 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
$HvcManagementAdministratorsSetRequestBody = Initialize-HvcManagementAdministratorsSetRequestBody -GroupNames "MyGroupNames"
Invoke-SetHvcManagementAdministrators -HvcManagementAdministratorsSetRequestBody $HvcManagementAdministratorsSetRequestBody
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"group_names":["string"]}' https://{api_host}/api/hvc/management/administrators
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: put
x-vmw-doc-deprecated-path: /rest/hvc/management/administrators
x-vmw-doc-operation: set
Availability
Added in 7.0U2
