com.vmware.vcenter.identity

Interface Providers

All Superinterfaces:

ProvidersTypes, Service

All Known Implementing Classes:

ProvidersStub

public interface Providers
extends Service, ProvidersTypes

The Providers interface provides methods to list, read and modify vCenter Server identity providers. This interface was added in vSphere API 7.0.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.identity.ProvidersTypes

ProvidersTypes.ActiveDirectoryOverLdap, ProvidersTypes.ConfigType, ProvidersTypes.CreateSpec, ProvidersTypes.IdmProtocol, ProvidersTypes.Info, ProvidersTypes.Oauth2AuthenticationMethod, ProvidersTypes.Oauth2CreateSpec, ProvidersTypes.Oauth2Info, ProvidersTypes.Oauth2Summary, ProvidersTypes.Oauth2UpdateSpec, ProvidersTypes.OidcCreateSpec, ProvidersTypes.OidcInfo, ProvidersTypes.OidcSummary, ProvidersTypes.OidcUpdateSpec, ProvidersTypes.Summary, ProvidersTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.identity.ProvidersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ProvidersTypes.CreateSpec spec) Create a vCenter Server identity provider.
void	create(ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Create a vCenter Server identity provider.
void	create(ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create a vCenter Server identity provider.
java.lang.String	create(ProvidersTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a vCenter Server identity provider.
void	delete(java.lang.String provider) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete a vCenter Server identity provider.
void	delete(java.lang.String provider, InvocationConfig invocationConfig) Delete a vCenter Server identity provider.
ProvidersTypes.Info	get(java.lang.String provider) Retrieve detailed information of the specified identity provider.
void	get(java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback) Retrieve detailed information of the specified identity provider.
void	get(java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieve detailed information of the specified identity provider.
ProvidersTypes.Info	get(java.lang.String provider, InvocationConfig invocationConfig) Retrieve detailed information of the specified identity provider.
java.util.List<ProvidersTypes.Summary>	list() Retrieve all identity providers.
void	list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback) Retrieve all identity providers.
void	list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Retrieve all identity providers.
java.util.List<ProvidersTypes.Summary>	list(InvocationConfig invocationConfig) Retrieve all identity providers.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update a vCenter Server identity provider.
void	update(java.lang.String provider, ProvidersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update a vCenter Server identity provider.

Method Detail

list

java.util.List<ProvidersTypes.Summary> list()

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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

Returns:

Commonly used information about the identity providers.

Throws:

Unauthorized - if authorization is not given to caller.

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

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

list

java.util.List<ProvidersTypes.Summary> list(InvocationConfig invocationConfig)

Retrieve all identity providers. This method was added in vSphere API 7.0.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:

Commonly used information about the identity providers.

Throws:

Unauthorized - if authorization is not given to caller.

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

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

list

void list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback)

Retrieve all identity providers. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Commonly used information about the identity providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Parameters:

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

list

void list(AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Retrieve all identity providers. This method was added in vSphere API 7.0.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:
Commonly used information about the identity providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Parameters:

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

invocationConfig - Configuration for the method invocation.

get

ProvidersTypes.Info get(java.lang.String provider)

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Returns:

Detailed information of the specified identity provider.

Throws:

Unauthorized - if authorization is not given to caller.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

get

ProvidersTypes.Info get(java.lang.String provider,
                        InvocationConfig invocationConfig)

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.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:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information of the specified identity provider.

Throws:

Unauthorized - if authorization is not given to caller.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

get

void get(java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback)

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
Detailed information of the specified identity provider.

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

get

void get(java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Retrieve detailed information of the specified identity provider. This method was added in vSphere API 7.0.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:
Detailed information of the specified identity provider.

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Read and VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(ProvidersTypes.CreateSpec spec)

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Parameters:

spec - the CreateSpec contains the information used to create the provider

Returns:

The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Throws:

Unauthorized - if authorization is not given to caller.

InvalidArgument - if invalid arguments are provided in createSpec.

AlreadyExists - if provider exists for provider ID in given spec.

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

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

create

java.lang.String create(ProvidersTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.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:

spec - the CreateSpec contains the information used to create the provider

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Throws:

Unauthorized - if authorization is not given to caller.

InvalidArgument - if invalid arguments are provided in createSpec.

AlreadyExists - if provider exists for provider ID in given spec.

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

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

create

void create(ProvidersTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in createSpec.
AlreadyExists - if provider exists for provider ID in given spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

Parameters:

spec - the CreateSpec contains the information used to create the provider

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

create

void create(ProvidersTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Create a vCenter Server identity provider. This method was added in vSphere API 7.0.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:
The identifier of the created identity provider. The return value will be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in createSpec.
AlreadyExists - if provider exists for provider ID in given spec.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Create and VcIdentityProviders.Manage.

Parameters:

spec - the CreateSpec contains the information used to create the provider

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String provider,
            ProvidersTypes.UpdateSpec spec)

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

Throws:

Unauthorized - if authorization is not given to caller.

InvalidArgument - if invalid arguments are provided in updateSpec.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Manage.

update

void update(java.lang.String provider,
            ProvidersTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.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:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

invocationConfig - Configuration for the method invocation.

Throws:

Unauthorized - if authorization is not given to caller.

InvalidArgument - if invalid arguments are provided in updateSpec.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Manage.

update

void update(java.lang.String provider,
            ProvidersTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in updateSpec.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

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

update

void update(java.lang.String provider,
            ProvidersTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Update a vCenter Server identity provider. This method was added in vSphere API 7.0.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.

Operation Errors:
Unauthorized - if authorization is not given to caller.
InvalidArgument - if invalid arguments are provided in updateSpec.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider to update The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

spec - the UpdateSpec contains the information used to update the provider

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String provider)

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

Throws:

Unauthorized - if authorization is not given to caller.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Manage.

delete

void delete(java.lang.String provider,
            InvocationConfig invocationConfig)

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.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:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

invocationConfig - Configuration for the method invocation.

Throws:

Unauthorized - if authorization is not given to caller.

NotFound - if no provider found with the given provider identifier.

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

• Method execution requires VcIdentityProviders.Manage.

delete

void delete(java.lang.String provider,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.0.0.

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

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

delete

void delete(java.lang.String provider,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Delete a vCenter Server identity provider. This method was added in vSphere API 7.0.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.

Operation Errors:
Unauthorized - if authorization is not given to caller.
NotFound - if no provider found with the given provider identifier.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIdentityProviders.Manage.

Parameters:

provider - the identifier of the provider to delete The parameter must be an identifier for the resource type: com.vmware.vcenter.identity.Providers.

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

invocationConfig - Configuration for the method invocation.