REST API - update
  1. Operations
  2. vcenter
  3. identity
  4. vc identity

vcenter identity vc identity: update

Update the VcIdentity for local domain with data in given UpdateSpec. 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/vc-identity

Request Body Structure:

{
    "spec" : {
        "signing_cert_chain" : {
            "cert_chain" : [
                "string",
                "string"
            ]
        },
        "label" : "string",
        "type" : "string",
        "oauth2_response_endpoint" : "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec update_spec VcIdentity update spec which contains the data to be updated.
spec.label string Label of the trust. A non-unique, user-readable label. 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 unspecified, leaves value unchanged.
spec.type string Type of trust, used to distinguish between different types of domains such as cloud or on-prem. 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 unspecified, leaves value unchanged.
spec.signing_cert_chain x509_cert_chain Signing certificate chain which will replace existing chain. The existing chain will continue to be used to validate tokens for at least the maximum lifetime of the tokens. 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 unspecified, leaves value unchanged.
spec.signing_cert_chain.cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 6.7.2.
spec.oauth2_response_endpoint string Response URL for web logons. 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.
400 invalid_argument if no arguments are provided in update spec.