REST API - list-task
  1. Operations
  2. vcenter
  3. trusted infrastructure
  4. trust authority clusters
  5. consumer principals

vcenter trusted infrastructure trust authority clusters consumer principals: list-task

Lists all policies configured on a specific cluster. This operation was added in vSphere API 7.0.0.0.

Request:

HTTP request

POST https://{server}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals

?action=query
&vmw-task=true
{
    "principals" : [
        {
            "id" : {
                "domain" : "string",
                "name" : "string"
            },
            "type" : "STS_USER"
        },
        {
            "id" : {
                "domain" : "string",
                "name" : "string"
            },
            "type" : "STS_USER"
        }
    ],
    "id" : [
        "obj-103",
        "obj-103"
    ],
    "issuer" : [
        "obj-103",
        "obj-103"
    ]
}

Path Parameters

Name Type Description
Required
cluster string The ID of the Trust Authority Cluster on which the profile is configured.

Body Parameters:

Name Type Description
bold = required
- filter_spec Optional. A FilterSpec specifying the profiles to be listed.
-.id string[] The unqiue identifier of a connection profile. This attribute was added in vSphere API 7.0.0.0.

Optional. If unset, no filtration will be performed by ID.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.esx.authentication.clientprofile. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.esx.authentication.clientprofile.
-.principals sts_principal[] The principal used by the vCenter to retrieve tokens. This attribute was added in vSphere API 7.0.0.0.

Optional. If unset, no filtration will be performed by principals.
-.principals[].id sts_principal_id The principal's ID. This attribute was added in vSphere API 7.0.0.0.
-.principals[].id.name string The principal's username. This attribute was added in vSphere API 7.0.0.0.
-.principals[].id.domain string The principal's domain. This attribute was added in vSphere API 7.0.0.0.
-.principals[].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.
-.issuer string[] The service which created and signed the security token. This attribute was added in vSphere API 7.0.0.0.

Optional. If unset, no filtration will be performed by issuer.When clients pass a value of this structure as a parameter, the field must contain identifiers 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 contain identifiers for the resource type: com.vmware.esx.authentication.trust.security-token-issuer.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string the list of profiles matching the filter for that cluster.

Errors:

HTTP Status Code Type Description
500 error if there is a generic error.
404 not_found if there is no profile configured with that ID.
401 unauthenticated if the user can not be authenticated.