Service - JwtToken

Class: VMware.Hv.JwtToken
See also: JwtPublicKeyInfo, JwtTokenGenerationSpec, JwtTokenInfo
Since: Horizon 7.4

Service Description

Service interface for JWT Token.

Methods

Methods defined in this Service
JwtToken_Generate, JwtToken_GetPublicKeys

JwtToken_Generate

Generates JWT token.

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

spec

JwtTokenGenerationSpec

Optional parameter. If not specifing any value, this should be set to null.

Return Value

Type	Description
JwtTokenInfo	The generated JWT token.

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_JWT_TOKEN_GENERATED	if JWT token creation succeeds.
VLSI_JWT_TOKEN_GENERATION_FAILED	if JWT token generation fails.

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="JwtToken_Generate" type="vdi:JwtToken_GenerateRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="JwtToken_GenerateResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:JwtTokenInfo" minOccurs="0"/>
               </sequence>
            </complexType>
         </element>

JwtToken_GetPublicKeys

Retrieves public keys for validating JWT token. This API can be used by unauthenticated sessions to retrieves public keys for validating JWT tokens.

Parameters

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

Return Value

Type	Description
JwtPublicKeyInfo[]	The JwtPublicKeyInfo list.

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="JwtToken_GetPublicKeys" type="vdi:JwtToken_GetPublicKeysRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vdi="urn:vdi" xmlns:vim25="urn:vim25" name="JwtToken_GetPublicKeysResponse">
            <complexType>
               <sequence>
                  <element name="returnval" type="vdi:JwtPublicKeyInfo" minOccurs="0" maxOccurs="unbounded"/>
               </sequence>
            </complexType>
         </element>