UserInfoClaimsPlugin (OpenAM Server Only 7.2.2 Documentation)

All Superinterfaces:

org.forgerock.oauth2.core.plugins.OAuth2Plugin

All Known Subinterfaces:

ScopeValidator
```
@Supported
public interface UserInfoClaimsPlugin
extends org.forgerock.oauth2.core.plugins.OAuth2Plugin
```
A plugin or (extension point) that fetches the resource owners information based on an issued access token.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UserInfoClaims`	`getUserInfo(org.forgerock.oauth2.core.ClientRegistration clientRegistration, AccessToken token, OAuth2Request request)`	Gets the resource owners information based on an issued access token.

- Method Detail
  - getUserInfo
```
@Supported
UserInfoClaims getUserInfo(org.forgerock.oauth2.core.ClientRegistration clientRegistration,
                           AccessToken token,
                           OAuth2Request request)
                    throws org.forgerock.oauth2.core.exceptions.UnauthorizedClientException,
                           org.forgerock.oauth2.core.exceptions.NotFoundException,
                           org.forgerock.oauth2.core.exceptions.ServerException,
                           InvalidRequestException
```
    Gets the resource owners information based on an issued access token.
    
    Parameters:
    
    clientRegistration - The client registration.
    
    token - The access token.
    
    request - The OAuth2 request.
    
    Returns:
    
    The UserInfoClaims.
    
    Throws:
    
    org.forgerock.oauth2.core.exceptions.UnauthorizedClientException - If the client's authorization fails.
    
    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 the client's authorization fails due to a server error.
    
    InvalidRequestException - If the client's authorization fails.