Get Broker Tenants Admin Client
Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. if you do not have all of the privileges described as follows: - Operation execution requires VcIdentityProviders.Manage.
Request
URLURL
https://{api_host}/api/vcenter/identity/broker/tenants/{tenant}/admin-client
Path Parameters
Path Parameters
string
tenant
Required
The tenant name for which the admin client token needs to be returned. The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.broker.tenant.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
IdentityBrokerTenantsTokenInfo
of type application/json
TokenInfo structure that contains a newly issued tenant admin client token.
{
"access_token": "string",
"expires_in": 0,
"token_type": "string"
}
string
access_token
Required
Tenant client access token issued by the authorization server.
string
token_type
Required
The type of the token issued. The access token type provides the client with the information required to successfully utilize the access token to make a protected resource request (along with type-specific attributes). The client MUST NOT use an access token if it does not understand the token type. “Bearer” token type as defined in RFC 6750 is supported.
integer
expires_in
Optional
The lifetime in seconds of the access token. For example, the value “3600” denotes that the access token will expire in one hour from the time the response was generated. unset if not applicable for issued token.
Errors
404
com.vmware.vapi.std.errors.not_found : if no tenant owned by vcenter trustmanagment service, with the input parameter found.
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
Invoke-GetTenantBrokerAdminClient -Tenant "MyTenant"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/identity/broker/tenants/{tenant}/admin-client
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.1.0
