com.vmware.vcenter.namespace_management.supervisors.identity

Interface Providers

All Superinterfaces:

ProvidersTypes, Service

All Known Implementing Classes:

ProvidersStub

public interface Providers
extends Service, ProvidersTypes

The Providers interface provides methods to configure identity management on a Supervisor. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

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

ProvidersTypes.CreateSpec, ProvidersTypes.Info, ProvidersTypes.SetSpec, ProvidersTypes.Summary, ProvidersTypes.UpdateSpec

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String supervisor, ProvidersTypes.CreateSpec spec) Create a new identity provider to be used with a Supervisor.
void	create(java.lang.String supervisor, ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Create a new identity provider to be used with a Supervisor.
void	create(java.lang.String supervisor, ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Create a new identity provider to be used with a Supervisor.
java.lang.String	create(java.lang.String supervisor, ProvidersTypes.CreateSpec spec, InvocationConfig invocationConfig) Create a new identity provider to be used with a Supervisor.
void	delete(java.lang.String supervisor, java.lang.String provider) Remove an identity provider configured with a given Supervisor.
void	delete(java.lang.String supervisor, java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback) Remove an identity provider configured with a given Supervisor.
void	delete(java.lang.String supervisor, java.lang.String provider, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Remove an identity provider configured with a given Supervisor.
void	delete(java.lang.String supervisor, java.lang.String provider, InvocationConfig invocationConfig) Remove an identity provider configured with a given Supervisor.
ProvidersTypes.Info	get(java.lang.String supervisor, java.lang.String provider) Returns information about an identity provider configured for a Supervisor.
void	get(java.lang.String supervisor, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback) Returns information about an identity provider configured for a Supervisor.
void	get(java.lang.String supervisor, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about an identity provider configured for a Supervisor.
ProvidersTypes.Info	get(java.lang.String supervisor, java.lang.String provider, InvocationConfig invocationConfig) Returns information about an identity provider configured for a Supervisor.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String supervisor) List the identity providers configured for a given Supervisor.
void	list(java.lang.String supervisor, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback) List the identity providers configured for a given Supervisor.
void	list(java.lang.String supervisor, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) List the identity providers configured for a given Supervisor.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String supervisor, InvocationConfig invocationConfig) List the identity providers configured for a given Supervisor.
void	set(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.SetSpec spec) Update the entire configuration for an existing identity provider used with a Supervisor.
void	set(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update the entire configuration for an existing identity provider used with a Supervisor.
void	set(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update the entire configuration for an existing identity provider used with a Supervisor.
void	set(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.SetSpec spec, InvocationConfig invocationConfig) Update the entire configuration for an existing identity provider used with a Supervisor.
void	update(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.UpdateSpec spec) Update an existing identity provider used with a Supervisor.
void	update(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update an existing identity provider used with a Supervisor.
void	update(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update an existing identity provider used with a Supervisor.
void	update(java.lang.String supervisor, java.lang.String provider, ProvidersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update an existing identity provider used with a Supervisor.

Method Detail

get

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

Returns information about an identity provider configured for a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - identifier for the Supervisor for which the identity provider is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - identifier for the identity provider that is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Returns:

An {#link Info} representing the requested identity provider.

Throws:

NotFound - if the given identity provider or Supervisor cannot be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

get

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

Returns information about an identity provider configured for a Supervisor. This method was added in vSphere API 8.0.0.1.

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:

supervisor - identifier for the Supervisor for which the identity provider is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - identifier for the identity provider that is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

invocationConfig - Configuration for the method invocation.

Returns:

An {#link Info} representing the requested identity provider.

Throws:

NotFound - if the given identity provider or Supervisor cannot be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

get

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

Returns information about an identity provider configured for a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
An {#link Info} representing the requested identity provider.

Operation Errors:
NotFound - if the given identity provider or Supervisor cannot be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

Parameters:

supervisor - identifier for the Supervisor for which the identity provider is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - identifier for the identity provider that is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

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

get

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

Returns information about an identity provider configured for a Supervisor. This method was added in vSphere API 8.0.0.1.

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:
An {#link Info} representing the requested identity provider.

Operation Errors:
NotFound - if the given identity provider or Supervisor cannot be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

Parameters:

supervisor - identifier for the Supervisor for which the identity provider is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - identifier for the identity provider that is being read. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String supervisor)

List the identity providers configured for a given Supervisor. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - the Supervisor for which identity providers are being listed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

Returns:

A list of {#link Summary} with details about the identity providers associated with a given Supervisor.

Throws:

NotFound - if the given Supervisor cannot be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String supervisor,
                                            InvocationConfig invocationConfig)

List the identity providers configured for a given Supervisor. This method was added in vSphere API 8.0.0.1.

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:

supervisor - the Supervisor for which identity providers are being listed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

invocationConfig - Configuration for the method invocation.

Returns:

A list of {#link Summary} with details about the identity providers associated with a given Supervisor.

Throws:

NotFound - if the given Supervisor cannot be found.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

list

void list(java.lang.String supervisor,
          AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback)

List the identity providers configured for a given Supervisor. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
A list of {#link Summary} with details about the identity providers associated with a given Supervisor.

Operation Errors:
NotFound - if the given Supervisor cannot be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

Parameters:

supervisor - the Supervisor for which identity providers are being listed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

list

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

List the identity providers configured for a given Supervisor. This method was added in vSphere API 8.0.0.1.

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:
A list of {#link Summary} with details about the identity providers associated with a given Supervisor.

Operation Errors:
NotFound - if the given Supervisor cannot be found.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the System.Read privilege on the Supervisor.

Parameters:

supervisor - the Supervisor for which identity providers are being listed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

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

invocationConfig - Configuration for the method invocation.

create

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

Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - the Supervisor for which the identity provider is being registered. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - the {#link CreateSpec} describing the identity provider to be registered.

Returns:

a unique identifier for the identity provider that was registered. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

Unsupported - if the specified Supervisor does not exist, or if an identity provider is already configured.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

create

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

Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created. This method was added in vSphere API 8.0.0.1.

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:

supervisor - the Supervisor for which the identity provider is being registered. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - the {#link CreateSpec} describing the identity provider to be registered.

invocationConfig - Configuration for the method invocation.

Returns:

a unique identifier for the identity provider that was registered. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

Unsupported - if the specified Supervisor does not exist, or if an identity provider is already configured.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

create

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

Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
a unique identifier for the identity provider that was registered. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
Unsupported - if the specified Supervisor does not exist, or if an identity provider is already configured.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the Supervisor for which the identity provider is being registered. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - the {#link CreateSpec} describing the identity provider to be registered.

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

create

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

Create a new identity provider to be used with a Supervisor. Currently, only a single identity provider can be created. This method was added in vSphere API 8.0.0.1.

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:
a unique identifier for the identity provider that was registered. The return value will be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
Unsupported - if the specified Supervisor does not exist, or if an identity provider is already configured.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the Supervisor for which the identity provider is being registered. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

spec - the {#link CreateSpec} describing the identity provider to be registered.

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

invocationConfig - Configuration for the method invocation.

update

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

Update an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#UpdateSpec} to be applied to the identity provider configuration.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

update

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

Update an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#UpdateSpec} to be applied to the identity provider configuration.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

update

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

Update an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#UpdateSpec} to be applied to the identity provider configuration.

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

update

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

Update an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#UpdateSpec} to be applied to the identity provider configuration.

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String supervisor,
         java.lang.String provider,
         ProvidersTypes.SetSpec spec)

Update the entire configuration for an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#link SetSpec} to be applied to the identity provider configuration.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

set

void set(java.lang.String supervisor,
         java.lang.String provider,
         ProvidersTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Update the entire configuration for an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#link SetSpec} to be applied to the identity provider configuration.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if the @{param.name spec} contains any errors.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

set

void set(java.lang.String supervisor,
         java.lang.String provider,
         ProvidersTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Update the entire configuration for an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#link SetSpec} to be applied to the identity provider configuration.

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

set

void set(java.lang.String supervisor,
         java.lang.String provider,
         ProvidersTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Update the entire configuration for an existing identity provider used with a Supervisor. This method was added in vSphere API 8.0.0.1.

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:
Error - if the system reports an error while responding to the request.
InvalidArgument - if the @{param.name spec} contains any errors.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier for the Supervisor associated with the identity provider to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be updated. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

spec - the {#link SetSpec} to be applied to the identity provider configuration.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String supervisor,
            java.lang.String provider)

Remove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider. This method was added in vSphere API 8.0.0.1.

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

Parameters:

supervisor - the identifier of the Supervisor which is associated with the identity provider being removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

delete

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

Remove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider. This method was added in vSphere API 8.0.0.1.

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:

supervisor - the identifier of the Supervisor which is associated with the identity provider being removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the given identity provider or Supervisor cannot be found.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

delete

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

Remove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider. This method was added in vSphere API 8.0.0.1.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier of the Supervisor which is associated with the identity provider being removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

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

delete

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

Remove an identity provider configured with a given Supervisor. This will result in users no longer being able to log in to either the Supervisor or any of its workload clusters with that identity provider. This method was added in vSphere API 8.0.0.1.

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:
Error - if the system reports an error while responding to the request.
NotFound - if the given identity provider or Supervisor cannot be found.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user is missing the Namespaces.Manage privilege on the Supervisor.

Parameters:

supervisor - the identifier of the Supervisor which is associated with the identity provider being removed. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor.Supervisor.

provider - the identifier for the identity provider that is to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.identity.Provider.

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

invocationConfig - Configuration for the method invocation.