List Trust Authority Clusters Consumer Principals Task
Lists all policies configured on a specific cluster.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals?action=query&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The ID of the Trust Authority Cluster on which the profile is configured. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsFilterSpec of mimetype application/json
Optional
A FilterSpec specifying the profiles to be listed. If {@term.unset} return all policies.
{
"id": [
"string"
],
"issuer": [
"string"
],
"principals": [
{
"id": {
"domain": "string",
"name": "string"
},
"type": "STS_USER"
}
]
}
array of
string
id
Optional
The unqiue identifier of a connection profile. 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.
array of
string
issuer
Optional
The service which created and signed the security token. 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.
array of
TrustedInfrastructureStsPrincipal
principals
Optional
The principal used by the vCenter to retrieve tokens. If unset, no filtration will be performed by principals.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. the list of profiles matching the filter for that cluster.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$TrustedInfrastructureStsPrincipalId = Initialize-TrustedInfrastructureStsPrincipalId -Name "MyName" -Domain "MyDomain"
$TrustedInfrastructureStsPrincipal = Initialize-TrustedInfrastructureStsPrincipal -Id $TrustedInfrastructureStsPrincipalId -Type "STS_USER"
$TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsFilterSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsFilterSpec -Id "MyId" -Principals $TrustedInfrastructureStsPrincipal -Issuer "MyIssuer"
Invoke-QueryClusterConsumerPrincipalsAsync -Cluster "MyCluster" -TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsFilterSpec $TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"id":["string"],"issuer":["string"],"principals":[{"id":{"domain":"string","name":"string"},"type":"STS_USER"}]}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals?action=query&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list_task
Availability
Added in 7.0.0.0
