Service - CertificateSSOConnector

Class: VMware.Hv.CertificateSSOConnector
See also: CertificateSSOConnectorId, CertificateSSOConnectorInfo, CertificateSSOConnectorSpec, MapEntry
Since: Horizon 7.0

Service Description

The Certificate SSO Connector service interface.

Methods

Methods defined in this Service
CertificateSSOConnector_Create, CertificateSSOConnector_Delete, CertificateSSOConnector_Get, CertificateSSOConnector_List, CertificateSSOConnector_Update

CertificateSSOConnector_Create

Creates a Certificate SSO Connector.

Privileges

Privilege	Description
ADMINISTRATOR	Administrator is required to create a connector.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the CertificateSSOConnector used to make the method call.
spec	CertificateSSOConnectorSpec	The specification of the connector.

Return Value

Type	Description
CertificateSSOConnectorId	The ID of the newly created connector.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_CERT_SSO_CONNECTOR_CREATED	If the connector was successfully created.
VLSI_CERT_SSO_CONNECTOR_CREATE_FAILED	If the connector could not be created.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_Create" type="vdi:CertificateSSOConnector_CreateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_CreateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:CertificateSSOConnectorId"/>
               </sequence>
            </complexType>
         </element>

CertificateSSOConnector_Delete

Deletes the specified Certificate SSO Connector.

Privileges

Privilege	Description
ADMINISTRATOR	Administrator is required to delete a connector.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the CertificateSSOConnector used to make the method call.
id	CertificateSSOConnectorId	The ID of the connector to delete.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_CERT_SSO_CONNECTOR_DELETED	If the connector was successfully deleted.
VLSI_CERT_SSO_CONNECTOR_DELETE_FAILED	If the connector could not be deleted.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_Delete" type="vdi:CertificateSSOConnector_DeleteRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_DeleteResponse">
            <complexType/>
         </element>

CertificateSSOConnector_Get

Retrieves information about a Certificate SSO Connector.

Privileges

Privilege	Description
ADMINISTRATOR_VIEW	Administrator (read-only) is required to retrieve information about a connector.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the CertificateSSOConnector used to make the method call.
id	CertificateSSOConnectorId	The ID of the connector.

Return Value

Type	Description
CertificateSSOConnectorInfo	Information about the specified connector.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_Get" type="vdi:CertificateSSOConnector_GetRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_GetResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:CertificateSSOConnectorInfo"/>
               </sequence>
            </complexType>
         </element>

CertificateSSOConnector_List

Lists the configured Certificate SSO Connectors.

Privileges

Privilege	Description
ADMINISTRATOR_VIEW	Administrator (read-only) is required to list connectors.

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the CertificateSSOConnector used to make the method call.

Return Value

Type	Description
CertificateSSOConnectorInfo[]	Information about the configured connectors.

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_List" type="vdi:CertificateSSOConnector_ListRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_ListResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:CertificateSSOConnectorInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>

CertificateSSOConnector_Update

Updates a Certificate SSO Connector.

Privileges

Privilege	Description
ADMINISTRATOR	Administrator is required to update a connector.

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the CertificateSSOConnector used to make the method call.

CertificateSSOConnectorId

The ID of the connector to update.

updates

MapEntry[]

Key value pairs describing attributes to be updated.

This parameter is an update map based on CertificateSSOConnectorInfo.

Return Value

Type	Description
None

Faults

Type	Description
EntityNotFound	Thrown if any specified entity cannot be found.
InsufficientPermission	Thrown if the user does not have sufficient permission to perform the operation.
InvalidArgument	Thrown if any specified argument is invalid.
InvalidType	Thrown if the type of any specified argument is invalid.
UnexpectedFault	Thrown if an unexpected error occurs while performing the operation.

Events

Event	Description
VLSI_CERT_SSO_CONNECTOR_UPDATED	If the connector was successfully updated.
VLSI_CERT_SSO_CONNECTOR_UPDATE_FAILED	If the connector could not be updated.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_Update" type="vdi:CertificateSSOConnector_UpdateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="CertificateSSOConnector_UpdateResponse">
            <complexType/>
         </element>