vcenter trusted infrastructure trust authority clusters consumer principals: info

The info structure contains the information necessary to establish trust between a workload vCenter and a Trust Authority Host. This structure was added in vSphere API 7.0.0.

Representation:

{
    "principal"{
        "id"{
            "domain""string",
            "name""string"
        },
        "type""STS_USER"
    },
    "certificates"[
        {
            "cert_chain"[
                "string",
                "string"
            ]
        },
        {
            "cert_chain"[
                "string",
                "string"
            ]
        }
    ],
    "health""NONE",
    "issuer_alias""obj-103",
    "id""obj-103",
    "message"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"{
            "<string>"{
                "dt""2015-01-01T22:13:05.651Z",
                "s""string",
                "d"1.5,
                "precision"1,
                "format""SHORT_DATE",
                "i"1,
                "l"{
                    "id""string",
                    "params"{
                        "<string>"{
                            "dt""2015-01-01T22:13:05.651Z",
                            "s""string",
                            "d"1.5,
                            "precision"1,
                            "format""SHORT_DATE",
                            "i"1,
                            "l"{
                                "id""string",
                                "params"{}
                            }
                        }
                    }
                }
            }
        }
    },
    "issuer""string"
}
{
    "principal"{
        "id"{
            "domain""string",
            "name""string"
        },
        "type""STS_USER"
    },
    "certificates"[
        {
            "cert_chain"[
                "string",
                "string"
            ]
        },
        {
            "cert_chain"[
                "string",
                "string"
            ]
        }
    ],
    "health""NONE",
    "issuer_alias""obj-103",
    "id""obj-103",
    "message"{
        "args"[
            "string",
            "string"
        ],
        "default_message""string",
        "localized""string",
        "id""string",
        "params"[
            {
                "value"{
                    "dt""2015-01-01T22:13:05.651Z",
                    "s""string",
                    "d"1.5,
                    "precision"1,
                    "format""SHORT_DATE",
                    "i"1,
                    "l"{
                        "id""string",
                        "params"[
                            {
                                "value"{
                                    "dt""2015-01-01T22:13:05.651Z",
                                    "s""string",
                                    "d"1.5,
                                    "precision"1,
                                    "format""SHORT_DATE",
                                    "i"1,
                                    "l"{
                                        "id""string",
                                        "params"[
                                            {
                                                "key""string"
                                            }
                                        ]
                                    }
                                },
                                "key""string"
                            }
                        ]
                    }
                },
                "key""string"
            }
        ]
    },
    "issuer""string"
}

Attributes:

Name Type Description
Required
-.id string The unqiue identifier of a connection profile. This attribute was added in vSphere API 7.0.0.

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.

-.principal sts_principal The principal used by the vCenter to retrieve tokens. Currently this is the vCenter solution user. This attribute was added in vSphere API 7.0.0.

-.principal.id sts_principal_id The principal's ID. This attribute was added in vSphere API 7.0.0.

-.principal.id.name string The principal's username. This attribute was added in vSphere API 7.0.0.

-.principal.id.domain string The principal's domain. This attribute was added in vSphere API 7.0.0.

-.principal.type string The type of the principal (user or group). This attribute was added in vSphere API 7.0.0.

The sts_principal_type enum can be either users or groups. This enumeration was added in vSphere API 7.0.0. Value is one of:
STS_USER: The principal is a user. This constant was added in vSphere API 7.0.0.
STS_GROUP: The principal is a group. This constant was added in vSphere API 7.0.0.

-.issuer_alias string A user-friendly alias of the service which created and signed the security token. This attribute was added in vSphere API 7.0.0.

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.

-.issuer string The service which created and signed the security token. This attribute was added in vSphere API 7.0.0.

-.certificates x509_cert_chain[] The certificates used by the vCenter STS to sign tokens. This attribute was added in vSphere API 7.0.0.

-.certificates[].cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 7.0.0.

-.health string The consistency of the profile across the hosts in the cluster. This attribute was added in vSphere API 7.0.0.

Defines the possible health states. This enumeration was added in vSphere API 7.0.0. Value is one of:
NONE: None. No status available. This constant was added in vSphere API 7.0.0.
OK: OK. Health is normal. This constant was added in vSphere API 7.0.0.
WARNING: Warning. Health is normal, however there is an issue that requires attention. This constant was added in vSphere API 7.0.0.
ERROR: Error. Not healthy. This constant was added in vSphere API 7.0.0.

-.message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

-.message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

-.message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Optional
-.message localizable_message A localizable message describing the health of the profile. This attribute was added in vSphere API 7.0.0.

Optional. If unset, the certificates won't be updated.

-.message.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.

-.message.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.