PingGateway

OAuth2InfoContext

This context holds the OAuth 2.0 information collected after successful authentication and authorization.

Avoid sharing an ID tokens from this context with other applications or relying on the ID token claims after authentication completes and the end user’s redirected to the final landing page.

If the ID token claims must remain fresh as long as the access token remains valid, align the access token and ID token lifetimes in the OpenID provider configuration.

Access the context at ${contexts.oauth2Info}.

Properties

"accessToken": string

The OAuth 2.0 access token.

"accessTokenResponse": string

The full OAuth 2.0 access token response content.

This response can contain outdated information when the access token was refreshed after the initial token was obtained. Use other methods to get up-to-date information.

"accessTokenExpiresIn": number

The OAuth 2.0 access token time to live in seconds, if any.

"clientEndpoint": string

The OAuth 2.0 client endpoint.

"clientRegistrationId": string

The OAuth 2.0 client registration identifier (client ID).

"idToken": string

The OpenID Connect ID token.

"idTokenClaims": string

The OpenID Connect ID token claims as a JSON Web Token (JWT) string

"refreshToken": string

The OAuth 2.0 refresh token.

"scopes": array of string

The OAuth 2.0 scopes.

"userInfo": array of map

The user information from the OpenID Connect UserInfo endpoint.