public interface Scope
Modifier and Type | Method and Description |
---|---|
Map |
evaluateScope(org.forgerock.openam.oauth2.model.CoreToken token)
This method is called on the /tokeninfo endpoint.
|
Map |
extraDataToReturnForAuthorizeEndpoint(Map parameters,
Map tokens)
This method is called before the authorize end point returns an response.
|
Map |
extraDataToReturnForTokenEndpoint(Map parameters,
org.forgerock.openam.oauth2.model.CoreToken token)
This method is called before the access_token end point returns an access token.
|
Map |
getUserInfo(org.forgerock.openam.oauth2.model.CoreToken token)
This method takes the scope values in the token and gets those user profile attributes for the owner of
the token.
|
Set |
scopeRequestedForAccessToken(Set requestedScopes,
Set availableScopes,
Set defaultScopes)
ScopeRequestedForAccessToken is called when a token is created and the token scope is requested.
|
Set |
scopeRequestedForRefreshToken(Set requestedScopes,
Set availableScopes,
Set allScopes,
Set defaultScopes)
ScopeRequestedForRefreshToken is called when the client tries to refresh an Access Token.
|
Set |
scopeToPresentOnAuthorizationPage(Set requestedScopes,
Set availableScopes,
Set defaultScopes)
scopeToPresentOnAuthorizationPage is called to decide what scopes will appear on the authorization page.
|
Set scopeToPresentOnAuthorizationPage(Set requestedScopes, Set availableScopes, Set defaultScopes)
requestedScopes
- The set of scopes requestedavailableScopes
- The set of scopes available for the client requesting the access tokendefaultScopes
- The set of scopes set in the client registration as defaultSet scopeRequestedForAccessToken(Set requestedScopes, Set availableScopes, Set defaultScopes)
requestedScopes
- The set of scopes requestedavailableScopes
- The set of scopes available for the client requesting the access tokendefaultScopes
- The set of scopes set in the client registration as defaultSet scopeRequestedForRefreshToken(Set requestedScopes, Set availableScopes, Set allScopes, Set defaultScopes)
requestedScopes
- The set of scopes requestedavailableScopes
- The set of scopes given to the original Access TokenallScopes
- All the available scopes for the clientdefaultScopes
- The set of scopes set in the client registration as defaultMap evaluateScope(org.forgerock.openam.oauth2.model.CoreToken token)
token
- An AccessToken that contains all the information about the tokenMap extraDataToReturnForTokenEndpoint(Map parameters, org.forgerock.openam.oauth2.model.CoreToken token)
parameters
- set of extra data to pass into the methodtoken
- the token created that will be returned with the extra data from this methodMap extraDataToReturnForAuthorizeEndpoint(Map parameters, Map tokens)
parameters
- map of extra data to pass into the methodtokens
- a map of token return names to the token objects. For example "code"=>tokenObjectMap getUserInfo(org.forgerock.openam.oauth2.model.CoreToken token)
token
- The OAuth2 bearer token containing the user to get the info aboutCopyright © 2010-2013, ForgeRock All Rights Reserved.