Developer Documentation

ConsumerPrincipalsInfo

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


Properties

Required Property Name Type Description
required certificates array of TrustedInfrastructureX509CertChain

The certificates used by the vCenter STS to sign tokens.

required health ConsumerPrincipalsHealth Enum

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

required id string

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.

required issuer string

The service which created and signed the security token.

required issuer_alias string

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.

optional message StdLocalizableMessage

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

required principal TrustedInfrastructureStsPrincipal

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

Feedback

Was this page helpful?