io.oauth.server.api

Class AuthorizationApi

java.lang.Object

io.oauth.server.api.AuthorizationApi

public class AuthorizationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthorizationApi()

Method Summary

Modifier and Type	Method and Description
AuthCallback	authorize(String clientId, String decision, String userId, String scope, String redirectUri, String state, String responseType) Authorize a user This endpoint is called when the user allow or deny permission \nin the decision page\n
TokenInfos	check(String accessToken) Check the validity of an access token and give back his permission, \nclient_id and user_id\n
String	getBasePath()
ApiInvoker	getInvoker()
static void	initialize(String providerId, String providerSecret)
void	setBasePath(String basePath)
TokenSet	token(String clientId, String clientSecret, String grantType, String scope, String code, String refreshToken) Access token retrieval (with code) or refresh (with refresh token)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthorizationApi

public AuthorizationApi()

Method Detail

authorize

public AuthCallback authorize(String clientId,
                              String decision,
                              String userId,
                              String scope,
                              String redirectUri,
                              String state,
                              String responseType)
                       throws ApiException

Authorize a user This endpoint is called when the user allow or deny permission \nin the decision page\n

Parameters:

clientId - Client ID

decision - Must be set to '1' if the user allowed the app, or '0' if the user denied the authorization

userId - User ID

scope - List of permission (space delimiter)

redirectUri - Redirect URI

state - CORS token

responseType - Response type

Returns:

AuthCallback

Throws:

ApiException

check

public TokenInfos check(String accessToken)
                 throws ApiException

Check the validity of an access token and give back his permission, \nclient_id and user_id\n

Parameters:

accessToken - The access token you want to check

Returns:

TokenInfos

Throws:

ApiException

getBasePath

public String getBasePath()

getInvoker

public ApiInvoker getInvoker()

initialize

public static void initialize(String providerId,
                              String providerSecret)

setBasePath

public void setBasePath(String basePath)

token

public TokenSet token(String clientId,
                      String clientSecret,
                      String grantType,
                      String scope,
                      String code,
                      String refreshToken)
               throws ApiException

Access token retrieval (with code) or refresh (with refresh token)

Parameters:

clientId - Client ID

clientSecret - Client Secret

grantType - authorization_code or client_credential or refresh_token

scope - Space separated scope list (e.g. \"email friends_list\"). Used only if grant_type = client_credential

code - Code received from /authorize step. Required if grant_type = authorization_code

refreshToken - Refresh token (long-live token) used to refresh the access token (short-live token). Required if grant_type = refresh_token

Returns:

TokenSet

Throws:

ApiException