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

OAuthAuthorizeOptions

data class OAuthAuthorizeOptions(val redirectUri: String = "io.fusionauth.app:/oauth2redirect", val idpHint: String? = null, val loginHint: String? = null, val deviceDescription: String? = null, val nonce: String? = null, val state: String? = null, val prompt: String? = null, val userCode: String? = null, val cancelIntent: ERROR CLASS: Symbol not found for Intent?? = null)

OAuthAuthorizeOptions is a data class that represents the options for the OAuth authorize request.

See FusionAuth OAuth 2.0 Authorization Endpoint for more information.

Constructors

constructor(redirectUri: String = "io.fusionauth.app:/oauth2redirect", idpHint: String? = null, loginHint: String? = null, deviceDescription: String? = null, nonce: String? = null, state: String? = null, prompt: String? = null, userCode: String? = null, cancelIntent: ERROR CLASS: Symbol not found for Intent?? = null)

Properties

cancelIntent

val cancelIntent: ERROR CLASS: Symbol not found for Intent??

An optional intent to be used when the user cancels the OAuth authorize request.

deviceDescription

val deviceDescription: String?

An optional human-readable description of the device used during login.

idpHint

val idpHint: String?

The identity provider hint to be used for the OAuth authorize request.

loginHint

val loginHint: String?

An optional email address or top level domain that can allow you to bypass the FusionAuth login page when using managed domains.

nonce

val nonce: String?

When this parameter is provided during the Authorization request, the value will be returned in the id_token.

prompt

val prompt: String?

The prompt parameter to be used for the OAuth authorize request. This parameter indicates whether the authorization server should prompt the end-user for reauthentication or consent. Standard OIDC values include: none, login, consent, select_account.

redirectUri

val redirectUri: String

The redirect URI to be used for the OAuth authorize request. Default is "io.fusionauth.app:/oauth2redirect".

state

val state: String?

An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client.

userCode

val userCode: String?

The end-user verification code.