forgerock-auth

4.4.0

forgerock-auth/org.forgerock.android.auth/OAuth2Client

OAuth2Client

open class OAuth2Client

Class to handle OAuth2 related endpoint

Constructors

constructor(@NonNull clientId: String, @NonNull scope: String, @NonNull redirectUri: String, @NonNull serverConfig: ServerConfig)

Properties

APPLICATION_X_WWW_FORM_URLENCODED

private val APPLICATION_X_WWW_FORM_URLENCODED: String = "application/x-www-form-urlencoded"

private val AUTHORIZE: Action

private open var clientId: String

The registered client identifier

private val CONTENT_TYPE: String = "Content-Type"

private val END_SESSION: Action

private val EXCHANGE_TOKEN: Action

private open var okHttpClient: OkHttpClient

private open var redirectUri: String

private val REFRESH_TOKEN: Action

private open var responseType: String

private val REVOKE_TOKEN: Action

private open var scope: String

private open var serverConfig: ServerConfig

private val STATE_LENGTH: Int = 16

private val TAG: String = "OAuth2Client"

Functions

open fun endSession(@NonNull idToken: String, listener: FRListener<Void>)

End the user session with end session endpoint.

open fun exchangeToken(@NonNull token: SSOToken, @NonNull additionalParameters: Map<String, String>, listener: FRListener<AccessToken>)

Sends an authorization request to the authorization service.

generateCodeChallenge

private open fun generateCodeChallenge(): PKCE

open fun generateState(): String

getAuthorizeUrl

open fun getAuthorizeUrl(): URL

private open fun getAuthorizeUrl(token: Token, pkce: PKCE, state: String, additionalParameters: Map<String, String>): URL

open fun getClientId(): String

getEndSessionUrl

open fun getEndSessionUrl(clientId: String, idToken: String): URL

getOkHttpClient

private open fun getOkHttpClient(): OkHttpClient

open fun getRedirectUri(): String

getResponseType

open fun getResponseType(): String

open fun getRevokeUrl(): URL

open fun getScope(): String

getServerConfig

open fun getServerConfig(): ServerConfig

open fun getTokenUrl(): URL

open fun refresh(@Nullable sessionToken: SSOToken, @NonNull refreshToken: String, listener: FRListener<AccessToken>)

Refresh the Access Token with the provided Refresh Token

open fun revoke(@NonNull accessToken: AccessToken, listener: FRListener<Void>)

Revoke the AccessToken, to revoke the access token, first look for refresh token to revoke, if not provided, will revoke with the access token.

open fun revoke(@NonNull accessToken: AccessToken, useRefreshToken: Boolean, listener: FRListener<Void>)

Revoke the AccessToken, to revoke the access token, first look for refresh token to revoke, if not provided or useRefreshToken = false, will revoke with the access token.

open fun token(@Nullable sessionToken: SSOToken, @NonNull code: String, pkce: PKCE, additionalParameters: Map<String, String>, handler: OAuth2ResponseHandler, listener: FRListener<AccessToken>)

Sends an token request to the authorization service.