Interface AccessTokenModifier

  • All Superinterfaces:
    org.forgerock.oauth2.core.plugins.OAuth2Plugin
    All Known Subinterfaces:
    ScopeValidator

    @Supported
    public interface AccessTokenModifier
    extends org.forgerock.oauth2.core.plugins.OAuth2Plugin
    A plugin or (extension point) that allows modification of the OAuth2 access token before the token is persisted/returned to the client.
    • Method Detail

      • modifyAccessToken

        @Supported
        void modifyAccessToken​(AccessToken accessToken,
                               OAuth2Request request)
                        throws org.forgerock.oauth2.core.exceptions.NotFoundException,
                               org.forgerock.oauth2.core.exceptions.ServerException,
                               org.forgerock.oauth2.core.exceptions.UnauthorizedClientException
        An extension point that allows modification of the OAuth2 access token before the token is persisted/returned to the client.
        Parameters:
        accessToken - The access token.
        request - The OAuth2 request.
        Throws:
        org.forgerock.oauth2.core.exceptions.NotFoundException - If the realm does not have an OAuth 2.0 provider service.
        org.forgerock.oauth2.core.exceptions.ServerException - If any internal server error occurs.
        org.forgerock.oauth2.core.exceptions.UnauthorizedClientException - If the client identity cannot be obtained.