org.forgerock.authz.modules.oauth2

Interface OAuth2AccessTokenValidator

All Known Implementing Classes:

RestOAuth2AccessTokenValidator

public interface OAuth2AccessTokenValidator

Plugin interface for allowing different implementations for determining whether a OAuth2 Access Token is valid and for retrieving scope on user profile information.

Since:

1.4.0

Method Summary

Modifier and Type	Method and Description
Promise<AccessTokenValidationResponse,OAuth2Exception>	validate(String accessToken) Validates whether the given access token is valid, by referring to the OAuth2 Provider and gaining user profile information as well.

Method Detail

validate

Promise<AccessTokenValidationResponse,OAuth2Exception> validate(String accessToken)

Validates whether the given access token is valid, by referring to the OAuth2 Provider and gaining user profile information as well.

Parameters:

accessToken - The access token to validate.

Returns:

An AccessTokenValidationResponse containing the result of the validation and scope and profile information.

Throws:

OAuth2Exception - If there is a problem validating the access token.