ID Token Details

This guide covers more details on ID tokens, supported claim types, and common errors.

Example ID Token

• The value for grantId maps to notificationPayload.id in the Notification API response.

Akoya ID JWT Claims

Akoya supports these claim types, but not all may be present.

• iss - Issuer of the JWT

• sub - Unique value to identify the consumer with the scope specific to the data provider

• aud - Data recipient

• exp - The token expiration time in Unix Epoch format

• iat - The time the system issued the token in Unix Epoch format

• at_hash - Access token hash value

For more: see the RFC on Identity Token claims.

Expired ID Token Error

If you use an expired ID token with a cluster (data) endpoint, it produces error code 602.

If you receive this error, you should refresh the tokens. Then, using the new ID token, make the call for data again.

Expired Refresh Token Error

If you make a request using the Token API with an expired refresh token, you receive an invalid_request error.

An expired refresh token requires the app to redirect the consumer back through the consent flow and account selection process to reauthorize and receive a new set of ID and refresh tokens.