REST API - update

vcenter trust vc trusts: update

Update a trust for given 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/trust/vc-trusts/{domain}

Path Parameters

Name Type Description
Required
domain string Unique identifier for a domain.

Request Body Structure:

{
    "spec"{
        "label""string",
        "signing_cert_chains"[
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            },
            {
                "cert_chain"[
                    "string",
                    "string"
                ]
            }
        ],
        "upn_suffixes"[
            "string",
            "string"
        ],
        "type""string",
        "group_map"[
            {
                "value"[
                    "string",
                    "string"
                ],
                "key""string"
            }
        ]
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec update_spec Trust 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_chains x509_cert_chain[] List of signing certificate chains which will replace existing chain. 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_chains[].cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 6.7.2.

spec.group_map list Mapping of group in existing token to a list of local SSO groups in the local domain for new token. If empty, deletes all existing mappings. 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.group_map[].key string
spec.group_map[].value string[]
spec.upn_suffixes string[] Lists the UPN suffixes used in this trust relationship. 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.

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 a VcTrusts does not exist for given domain.
400 invalid_argument if no arguments are provided in update spec.