FusionAuth Android SDK/io.fusionauth.mobilesdk.oauth/OAuthAuthorizationService

OAuthAuthorizationService

class OAuthAuthorizationService

OAuthAuthorizationService class is responsible for handling OAuth authorization and authorization process. It provides methods to authorize the user, handle the redirect intent, fetch user information, perform logout, retrieve fresh access token, and get the authorization service.

Types

object Companion

Properties

additionalScopes

val additionalScopes: Set<String>

Additional scopes to be requested during authorization. Default is empty.

allowUnsecureConnection

val allowUnsecureConnection: Boolean

Boolean value indicating whether unsecure connections are allowed.

val clientId: String

The client ID registered in the FusionAuth server.

val context: ERROR CLASS: Symbol not found for Context

The Android application context.

val fusionAuthUrl: String

The URL of the FusionAuth server.

val locale: String?

The locale to be used for authorization. Default is null.

val tenantId: String?

The tenant ID, or null if not applicable.

val tokenManager: TokenManager?

The token manager to handle token storage and retrieval, or null if not used.

Functions

suspend fun authorize(completedIntent: ERROR CLASS: Symbol not found for Intent, options: OAuthAuthorizeOptions? = null)

Authorizes the user using OAuth authorization.

freshAccessToken

suspend fun freshAccessToken(): String?

Retrieves a fresh access token.

suspend fun getUserInfo(): UserInfo?

Retrieves the user information for the authenticated user.

suspend fun handleRedirect(intent: ERROR CLASS: Symbol not found for Intent): FusionAuthState

Handles the redirect intent from the authorization process.

fun isAuthorized(intent: ERROR CLASS: Symbol not found for Intent): Boolean

Checks if the authorization process has succeeded by examining the given intent.

fun isCancelled(intent: ERROR CLASS: Symbol not found for Intent): Boolean

Checks if the authorization process has been cancelled by examining the given intent.

fun isLoggedOut(intent: ERROR CLASS: Symbol not found for Intent): Boolean

Checks if the logout process has succeeded by examining the given intent.

suspend fun logout(completedIntent: ERROR CLASS: Symbol not found for Intent, options: OAuthLogoutOptions? = null)

Log out the user.