forgerock-auth

4.7.0

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

OAuth2Client

class OAuth2Client(val clientId: String, val scope: String, val redirectUri: String, val signOutRedirectUri: String, val serverConfig: ServerConfig)

Class to handle OAuth2 related endpoint

Constructors

constructor(clientId: String, scope: String, redirectUri: String, signOutRedirectUri: String, serverConfig: ServerConfig)

Types

object Companion

OAuth2ClientBuilder

class OAuth2ClientBuilder

Properties

val authorizeUrl: URL

val clientId: String

The registered client identifier

val endSessionUrl: URL

private val okHttpClient: OkHttpClient

val redirectUri: String

val responseType: String

val revokeUrl: URL

val scope: String

val serverConfig: ServerConfig

signOutRedirectUri

val signOutRedirectUri: String

val tokenUrl: URL

Functions

fun endSession(idToken: String, listener: FRListener<Void?>)

End the user session with end session endpoint.

endSessionWithBrowser

fun endSessionWithBrowser(idToken: String, oAuth2Client: OAuth2Client, appAuthConfiguration: AppAuthConfiguration, listener: FRListener<Void?>)

End the user session with end session endpoint with browser. This method will open the browser to end the session.

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

Sends an authorization request to the authorization service.

generateCodeChallenge

private fun generateCodeChallenge(): PKCE

getAuthorizeUrl

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

getEndSessionUrl

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

fun refresh(sessionToken: SSOToken?, refreshToken: String, listener: FRListener<AccessToken>)

Refresh the Access Token with the provided Refresh Token

fun revoke(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.

fun revoke(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.

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

Sends an token request to the authorization service.