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

NameTypeDescription
_thisManagedObjectReference A reference to the JwtToken used to make the method call.
specJwtTokenGenerationSpec


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

Return Value

Type Description
JwtTokenInfoThe generated JWT token.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown 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



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

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

Return Value

Type Description
JwtPublicKeyInfo[]The JwtPublicKeyInfo list.

Faults

Type Description
EntityNotFoundThrown if any specified entity cannot be found.
InsufficientPermissionThrown if the user does not have sufficient permission to perform the operation.
InvalidArgumentThrown if any specified argument is invalid.
InvalidTypeThrown if the type of any specified argument is invalid.
UnexpectedFaultThrown if an unexpected error occurs while performing the operation.

Show WSDL type definition