com.vmware.vcenter.identity.broker.tenants

Interface OperatorClient

All Superinterfaces:

OperatorClientTypes, Service

All Known Implementing Classes:

OperatorClientStub

public interface OperatorClient
extends Service, OperatorClientTypes

The OperatorClient interface provides methods to read the token info of operator client. The operator client belongs to the pre-configured HWS tenant, that was created at bootstrap/installation of broker. The operator client tokens can be used to call the tenant management APIs like create, get and delete of 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.OperatorClientTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TokenInfo	get() Return the operator client token info in Broker.
void	get(AsyncCallback<TokenInfo> asyncCallback) Return the operator client token info in Broker.
void	get(AsyncCallback<TokenInfo> asyncCallback, InvocationConfig invocationConfig) Return the operator client token info in Broker.
TokenInfo	get(InvocationConfig invocationConfig) Return the operator client token info in Broker.

Method Detail

get

TokenInfo get()

Return the operator client token info in Broker. The operator client was created at bootstrap or installation of broker. This token can be used to manage tenant entity APIs. 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.

Returns:

TokenInfo class that contains a newly issued operator client token.

Throws:

Error - if any other error occurs.

NotFound - if no operator client details 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(InvocationConfig invocationConfig)

Return the operator client token info in Broker. The operator client was created at bootstrap or installation of broker. This token can be used to manage tenant entity APIs. 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:

invocationConfig - Configuration for the method invocation.

Returns:

TokenInfo class that contains a newly issued operator client token.

Throws:

Error - if any other error occurs.

NotFound - if no operator client details 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(AsyncCallback<TokenInfo> asyncCallback)

Return the operator client token info in Broker. The operator client was created at bootstrap or installation of broker. This token can be used to manage tenant entity APIs. 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 operator client token.

Operation Errors:
Error - if any other error occurs.
NotFound - if no operator client details 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:

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

get

void get(AsyncCallback<TokenInfo> asyncCallback,
         InvocationConfig invocationConfig)

Return the operator client token info in Broker. The operator client was created at bootstrap or installation of broker. This token can be used to manage tenant entity APIs. 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 operator client token.

Operation Errors:
Error - if any other error occurs.
NotFound - if no operator client details 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:

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

invocationConfig - Configuration for the method invocation.