sdk/com.oursky.authgear/AuthenticateOptions

AuthenticateOptions

data class AuthenticateOptions @JvmOverloads constructor(var redirectUri: String, var xState: String? = null, var prompt: List<PromptOption>? = null, var uiLocales: List<String>? = null, var colorScheme: ColorScheme? = null, var wechatRedirectURI: String? = null, var page: String? = null, var authenticationFlowGroup: String? = null, var oauthProviderAlias: String? = null)

Authorization options.

Constructors

Link copied to clipboard
@JvmOverloads
constructor(redirectUri: String, xState: String? = null, prompt: List<PromptOption>? = null, uiLocales: List<String>? = null, colorScheme: ColorScheme? = null, wechatRedirectURI: String? = null, page: String? = null, authenticationFlowGroup: String? = null, oauthProviderAlias: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
var authenticationFlowGroup: String?

Authentication flow group

Link copied to clipboard
var colorScheme: ColorScheme?

Theme override

Link copied to clipboard
var oauthProviderAlias: String?

OAuth provider alias

Link copied to clipboard
var page: String?

Which page to open initially. Valid values are "login" and "signup".

Link copied to clipboard
var prompt: List<PromptOption>?

OIDC prompt parameter.

Link copied to clipboard
var redirectUri: String

Redirection URI to which the response will be sent after authorization.

Link copied to clipboard
var uiLocales: List<String>?

UI locale tags

Link copied to clipboard
var wechatRedirectURI: String?

WeChat redirect uri is needed when integrating WeChat login The wechatRedirectURI will be called when user click the login with WeChat button

Link copied to clipboard
var xState: String?

Use this parameter to provide parameters from the client application to Custom UI. The string in xState can be accessed by the Custom UI. Ignore this parameter if default AuthUI is used