Stytch Android/com.stytch.sdk.b2b.oauth/OAuth/Provider/StartParameters

StartParameters

data class StartParameters @JvmOverloads constructor(val context: Activity, val oAuthRequestIdentifier: Int, val organizationId: String? = null, val organizationSlug: String? = null, val loginRedirectUrl: String? = null, val signupRedirectUrl: String? = null, val customScopes: List<String>? = null, val providerParams: Map<String, String>? = null)

A data class wrapping the parameters necessary to start an OAuth flow for a specific provider

Constructors

StartParameters

@JvmOverloads

constructor(context: Activity, oAuthRequestIdentifier: Int, organizationId: String? = null, organizationSlug: String? = null, loginRedirectUrl: String? = null, signupRedirectUrl: String? = null, customScopes: List<String>? = null, providerParams: Map<String, String>? = null)

Properties

context

val context: Activity

the calling Activity for launching the browser

customScopes

val customScopes: List<String>? = null

Any additional scopes to be requested from the identity provider.

loginRedirectUrl

val loginRedirectUrl: String? = null

The url an existing user is redirected to after authenticating with the identity provider. This should be a url that redirects back to your app. If this value is not passed, the default login redirect URL set in the Stytch Dashboard is used. If you have not set a default login redirect URL, an error is returned.

oAuthRequestIdentifier

val oAuthRequestIdentifier: Int

is an ID for the return intent from the OAuth flow

organizationId

val organizationId: String? = null

The id of the organization the member belongs to.

organizationSlug

val organizationSlug: String? = null

The slug of the organization the member belongs to

providerParams

val providerParams: Map<String, String>? = null

An optional mapping of provider specific values to pass through to the OAuth provider

signupRedirectUrl

val signupRedirectUrl: String? = null

The url a new user is redirected to after authenticating with the identity provider. This should be a url that redirects back to your app. If this value is not passed, the default sign-up redirect URL set in the Stytch Dashboard is used. If you have not set a default sign-up redirect URL, an error is returned.