REST API - update

vcenter identity foreign security principals: update

Update a foreign security principal. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

PATCH https://{server}/rest/vcenter/identity/foreign-security-principals/{id}

Path Parameters

Name	Type	Description
Required
id	string	the principal identifier.

Request Body Structure:

{
    "spec" : {
        "domain" : "string",
        "name" : "string",
        "group_names" : [
            "string",
            "string"
        ],
        "group_ids" : [
            "string",
            "string"
        ]
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	update_spec	the information to update the principal.
spec.name	string	The name of the principal. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, leaves value unchanged.
spec.domain	string	The domain that the principal belongs to. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, leaves value unchanged.
spec.group_names	string[]	The names of groups that the principal is a member of. If the list is empty, deletes all groups. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, leaves value unchanged.
spec.group_ids	string[]	The ids of groups that the principal is a member of. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, leaves value unchanged.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code	Type	Description
403	unauthorized	if authorization is not given to caller.
404	not_found	if the principal is not found.
400	invalid_argument	if the spec contains invalid information