REST API - get
  1. Operations
  2. vcenter
  3. trusted infrastructure
  4. principal

vcenter trusted infrastructure principal: get

Returns information about the STS used by this vCenter instance. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

GET https://{server}/api/vcenter/trusted-infrastructure/principal

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "principal" : {
        "id" : {
            "domain" : "string",
            "name" : "string"
        },
        "type" : "STS_USER"
    },
    "certificates" : [
        {
            "cert_chain" : [
                "string",
                "string"
            ]
        },
        {
            "cert_chain" : [
                "string",
                "string"
            ]
        }
    ],
    "name" : "string",
    "issuer" : "string"
}

Headers:

None

Type:

Name Type Description
bold = required
- info @{link Info} a summary containing the certificates used to sign tokens and the solution user used to retrieve them.
-.certificates x509_cert_chain[] The certificates used by the STS to sign tokens for this vCenter. This attribute was added in vSphere API 7.0.0.0.
-.certificates[].cert_chain string[] Certificate chain in base64 format. This attribute was added in vSphere API 7.0.0.0.
-.issuer string The service which created and signed the security token. This attribute was added in vSphere API 7.0.0.0.
-.principal sts_principal The principal used by this vCenter instance to retrieve tokens. Currently this is the vCenter solution user. This attribute was added in vSphere API 7.0.0.0.
-.principal.id sts_principal_id The principal's ID. This attribute was added in vSphere API 7.0.0.0.
-.principal.id.name string The principal's username. This attribute was added in vSphere API 7.0.0.0.
-.principal.id.domain string The principal's domain. This attribute was added in vSphere API 7.0.0.0.
-.principal.type string The type of the principal (user or group). This attribute was added in vSphere API 7.0.0.0.

The sts_principal_type enum can be either users or groups. This enumeration was added in vSphere API 7.0.0.0. Value is one of:
STS_USER: The principal is a user. This constant was added in vSphere API 7.0.0.0.
STS_GROUP: The principal is a group. This constant was added in vSphere API 7.0.0.0.
-.name string The user-friednly name of the vCenter. This attribute was added in vSphere API 7.0.0.0.

Errors:

HTTP Status Code Type Description
500 error if there is a generic error.
401 unauthenticated if the user can not be authenticated.