com.adaptris.permissions.security.access.auth.api

Class TokenApi

java.lang.Object

com.adaptris.permissions.security.access.auth.api.TokenApi

public class TokenApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TokenApi()
TokenApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
Token	token(java.lang.String authorization, java.lang.String username, java.lang.String password, java.lang.String refreshToken, java.lang.String scope, java.lang.String grantType) Logins a user using username and password
com.squareup.okhttp.Call	tokenAsync(java.lang.String authorization, java.lang.String username, java.lang.String password, java.lang.String refreshToken, java.lang.String scope, java.lang.String grantType, ApiCallback<Token> callback) Logins a user using username and password (asynchronously)
ApiResponse<Token>	tokenWithHttpInfo(java.lang.String authorization, java.lang.String username, java.lang.String password, java.lang.String refreshToken, java.lang.String scope, java.lang.String grantType) Logins a user using username and password

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenApi

public TokenApi()

TokenApi

public TokenApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

token

public Token token(java.lang.String authorization,
                   java.lang.String username,
                   java.lang.String password,
                   java.lang.String refreshToken,
                   java.lang.String scope,
                   java.lang.String grantType)
            throws ApiException

Logins a user using username and password

Parameters:

authorization - (optional)

username - Required for 'password' grant_type (optional)

password - Required for 'password' grant_type (optional)

refreshToken - Required for 'refresh_token' grant_type (optional)

scope - Optional request scope (not supported yet) (optional)

grantType - (optional, default to password)

Returns:

Token

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

tokenWithHttpInfo

public ApiResponse<Token> tokenWithHttpInfo(java.lang.String authorization,
                                            java.lang.String username,
                                            java.lang.String password,
                                            java.lang.String refreshToken,
                                            java.lang.String scope,
                                            java.lang.String grantType)
                                     throws ApiException

Logins a user using username and password

Parameters:

authorization - (optional)

username - Required for 'password' grant_type (optional)

password - Required for 'password' grant_type (optional)

refreshToken - Required for 'refresh_token' grant_type (optional)

scope - Optional request scope (not supported yet) (optional)

grantType - (optional, default to password)

Returns:

ApiResponse<Token>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

tokenAsync

public com.squareup.okhttp.Call tokenAsync(java.lang.String authorization,
                                           java.lang.String username,
                                           java.lang.String password,
                                           java.lang.String refreshToken,
                                           java.lang.String scope,
                                           java.lang.String grantType,
                                           ApiCallback<Token> callback)
                                    throws ApiException

Logins a user using username and password (asynchronously)

Parameters:

authorization - (optional)

username - Required for 'password' grant_type (optional)

password - Required for 'password' grant_type (optional)

refreshToken - Required for 'refresh_token' grant_type (optional)

scope - Optional request scope (not supported yet) (optional)

grantType - (optional, default to password)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object