com.vmware.vcenter.identity.broker.tenants

Interface AdminClient

All Superinterfaces:

AdminClientTypes, Service

All Known Implementing Classes:

AdminClientStub

public interface AdminClient
extends Service, AdminClientTypes

The AdminClient interface provides methods to read the token info of tenant admin client. The tenant client belongs to the pre-configured tenant(s), that were created at bootstrap of vcenter trustmanagement service. The tenant admin client tokens can be used to perform API invocations within a tenant entity. This interface was added in vSphere API 8.0.1.0.

Field Summary

Fields inherited from interface com.vmware.vcenter.identity.broker.tenants.AdminClientTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TokenInfo	get(java.lang.String tenant) Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service.
void	get(java.lang.String tenant, AsyncCallback<TokenInfo> asyncCallback) Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service.
void	get(java.lang.String tenant, AsyncCallback<TokenInfo> asyncCallback, InvocationConfig invocationConfig) Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service.
TokenInfo	get(java.lang.String tenant, InvocationConfig invocationConfig) Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service.

Method Detail

get

TokenInfo get(java.lang.String tenant)

Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

tenant - 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.

Returns:

TokenInfo class that contains a newly issued tenant admin client token.

Throws:

Error - if any other error occurs.

NotFound - if no tenant owned by vcenter trustmanagment service, with the input parameter found.

Unauthenticated - if not authenticated.

Unauthorized - if not authorized to invoke the operation.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

get

TokenInfo get(java.lang.String tenant,
              InvocationConfig invocationConfig)

Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

tenant - 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.

invocationConfig - Configuration for the method invocation.

Returns:

TokenInfo class that contains a newly issued tenant admin client token.

Throws:

Error - if any other error occurs.

NotFound - if no tenant owned by vcenter trustmanagment service, with the input parameter found.

Unauthenticated - if not authenticated.

Unauthorized - if not authorized to invoke the operation.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

get

void get(java.lang.String tenant,
         AsyncCallback<TokenInfo> asyncCallback)

Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
TokenInfo class that contains a newly issued tenant admin client token.

Operation Errors:
Error - if any other error occurs.
NotFound - if no tenant owned by vcenter trustmanagment service, with the input parameter found.
Unauthenticated - if not authenticated.
Unauthorized - if not authorized to invoke the operation.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

tenant - 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.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String tenant,
         AsyncCallback<TokenInfo> asyncCallback,
         InvocationConfig invocationConfig)

Returns the tenant admin client token info associated with pre-configured tenant(s) owned by vcenter trustmanagment service. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
TokenInfo class that contains a newly issued tenant admin client token.

Operation Errors:
Error - if any other error occurs.
NotFound - if no tenant owned by vcenter trustmanagment service, with the input parameter found.
Unauthenticated - if not authenticated.
Unauthorized - if not authorized to invoke the operation.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

tenant - 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.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.