AUauthlete
Jose Object

Verify JOSE

Changed on

This API verifies a JOSE object.

post/api/{serviceId}/jose/verify

Request

  • Base URL
    https://us.authlete.com
  • URL
    https://us.authlete.com/api/{serviceId}/jose/verify
  • Auth
    HTTP bearer

Path parameters

serviceIdstring required

A service ID.

Request body

josestring required

A JOSE object.

mandatoryClaimsstring[]

Mandatory claims that are required to be included in the JOSE object.

clockSkewinteger

Allowable clock skew in seconds.

clientIdentifierstring

The identifier of the client application whose keys are required for verification of the JOSE object.

signedByClientboolean

The flag which indicates whether the signature of the JOSE object has been signed by a client application with the client's private key or a shared symmetric key.

Response

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

validboolean

The result of the verification on the JOSE object.

signatureValidboolean

The result of the signature verification.

missingClaimsstring[]

The list of missing claims.

invalidClaimsstring[]

The list of invalid claims.

errorDescriptionsstring[]

The list of error messages.

Changes