TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsInfo

The ConsumerPrincipals.Info structure contains the information necessary to establish trust between a workload vCenter and a Trust Authority Host.


Properties

certificates Required

The certificates used by the vCenter STS to sign tokens.


health Required

The consistency of the profile across the hosts in the cluster.

Possible values are: NONEOKWARNINGERROR


string
id Required

The unqiue identifier of a connection profile. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.authentication.clientprofile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.


string
issuer Required

The service which created and signed the security token.


string
issuer_alias Required

A user-friendly alias of the service which created and signed the security token. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.authentication.trust.security-token-issuer.


message Optional

A localizable message describing the health of the profile. If unset, the certificates won’t be updated.


principal Required

The principal used by the vCenter to retrieve tokens. Currently this is the vCenter solution user.

JSON Example

{
    "certificates": [
        {
            "cert_chain": [
                "string"
            ]
        }
    ],
    "health": "enum",
    "id": "string",
    "issuer": "string",
    "issuer_alias": "string",
    "principal": {
        "id": {
            "domain": "string",
            "name": "string"
        },
        "type": "enum"
    }
}
Feedback

Was this page helpful?