Create Trust Authority Clusters Consumer Principals Task
Creates a profile with the specified connection information on all hosts from a Trust Authority Cluster.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals?vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The ID of the Trust Authority Cluster to configure. 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
TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsCreateSpec of mimetype application/json
Required
The CreateSpec specifying the connection information.
{
"certificates": [
{
"cert_chain": [
"string"
]
}
],
"issuer": "string",
"issuer_alias": "string",
"principal": {
"id": {
"domain": "string",
"name": "string"
},
"type": "STS_USER"
}
}
array of
TrustedInfrastructureX509CertChain
certificates
Required
The certificates used by the vCenter STS to sign tokens.
string
issuer
Required
The service which created and signed the security token.
string
issuer_alias
Required
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.
principal
Required
The principal used by the vCenter to retrieve tokens.
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. a unique identifier of the profile The result will be an identifier for the resource type: com.vmware.esx.authentication.clientprofile.
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
$TrustedInfrastructureX509CertChain = Initialize-TrustedInfrastructureX509CertChain -CertChain "MyCertChain"
$TrustedInfrastructureStsPrincipalId = Initialize-TrustedInfrastructureStsPrincipalId -Name "MyName" -Domain "MyDomain"
$TrustedInfrastructureStsPrincipal = Initialize-TrustedInfrastructureStsPrincipal -Id $TrustedInfrastructureStsPrincipalId -Type "STS_USER"
$TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsCreateSpec = Initialize-TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsCreateSpec -Certificates $TrustedInfrastructureX509CertChain -IssuerAlias "MyIssuerAlias" -Issuer "MyIssuer" -Principal $TrustedInfrastructureStsPrincipal
Invoke-CreateClusterConsumerPrincipalsAsync -Cluster "MyCluster" -TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsCreateSpec $TrustedInfrastructureTrustAuthorityClustersConsumerPrincipalsCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"certificates":[{"cert_chain":["string"]}],"issuer":"string","issuer_alias":"string","principal":{"id":{"domain":"string","name":"string"},"type":"STS_USER"}}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-clusters/{cluster}/consumer-principals?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
Availability
Added in 7.0.0.0
