com.vmware.vcenter.trusted_infrastructure

Interface Principal

All Superinterfaces:

PrincipalTypes, Service

All Known Implementing Classes:

PrincipalStub

public interface Principal
extends Service, PrincipalTypes

The Principal interface contains information about the certificates which sign the tokens used by vCenter for authentication. This interface was added in vSphere API 7.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.PrincipalTypes

PrincipalTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.PrincipalTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
PrincipalTypes.Info	get() Returns information about the STS used by this vCenter instance.
void	get(AsyncCallback<PrincipalTypes.Info> asyncCallback) Returns information about the STS used by this vCenter instance.
void	get(AsyncCallback<PrincipalTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about the STS used by this vCenter instance.
PrincipalTypes.Info	get(InvocationConfig invocationConfig) Returns information about the STS used by this vCenter instance.

Method Detail

get

PrincipalTypes.Info get()

Returns information about the STS used by this vCenter instance. This method was added in vSphere API 7.0.0.

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

Returns:

@{link Info} a summary containing the certificates used to sign tokens and the solution user used to retrieve them.

Throws:

Error - if there is a generic error.

Unauthenticated - if the user can not be authenticated.

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

• Method execution requires TrustedAdmin.ReadStsInfo.

get

PrincipalTypes.Info get(InvocationConfig invocationConfig)

Returns information about the STS used by this vCenter instance. This method was added in vSphere API 7.0.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:

@{link Info} a summary containing the certificates used to sign tokens and the solution user used to retrieve them.

Throws:

Error - if there is a generic error.

Unauthenticated - if the user can not be authenticated.

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

• Method execution requires TrustedAdmin.ReadStsInfo.

get

void get(AsyncCallback<PrincipalTypes.Info> asyncCallback)

Returns information about the STS used by this vCenter instance. This method was added in vSphere API 7.0.0.

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

Invocation Result:

Parameters:

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

get

void get(AsyncCallback<PrincipalTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about the STS used by this vCenter instance. This method was added in vSphere API 7.0.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:

Parameters:

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

invocationConfig - Configuration for the method invocation.