arcgis-maps-kotlin-toolkit/com.arcgismaps.toolkit.authentication

Package-level declarations

Types

Handles OAuth sign-in and Identity-Aware Proxy (IAP) sign-in/sign-out flows by launching a Custom Tab for user interaction.

AuthenticatorState

sealed interface AuthenticatorState : NetworkAuthenticationChallengeHandler, ArcGISAuthenticationChallengeHandler

Handles authentication challenges and exposes state for the Authenticator to display to the user.

BrowserAuthenticationChallenge

sealed class BrowserAuthenticationChallenge

Represents different types of browser-based authentication challenges.

ClientCertificateChallenge

data class ClientCertificateChallenge(val keyChainAliasCallback: KeyChainAliasCallback, val onCancel: () -> Unit)

Represents an authentication challenge requiring a client certificate.

OAuthUserSignInActivity

class ~~OAuthUserSignInActivity~~

An activity that is responsible for launching a CustomTabs activity and to receive and process the redirect intent as a result of a user completing the CustomTabs prompt.

ServerTrustChallenge

class ServerTrustChallenge(val challenge: NetworkAuthenticationChallenge, onUserResponseReceived: (Boolean) -> Unit)

Represents a NetworkAuthenticationChallenge of type NetworkAuthenticationType.ServerTrust.

UsernamePasswordChallenge

class UsernamePasswordChallenge(val url: String, onUsernamePasswordReceived: (username: String, password: String) -> Unit, val cause: Throwable? = null, onCancel: () -> Unit)

Represents an authentication challenge requiring a username and password.

Functions

Authenticator

@Composable

fun Authenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier)

@Composable

fun ~~Authenticator~~(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingOAuthUserSignIn: (OAuthUserSignIn) -> Unit? = null)

@JvmName(name = "AuthenticatorWithBrowserAuthenticationChallenge")

@Composable

fun Authenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingBrowserAuthenticationChallenge: (BrowserAuthenticationChallenge) -> Unit)

Displays appropriate Authentication UI when an authentication challenge is issued.

AuthenticatorState

fun AuthenticatorState(setAsArcGISAuthenticationChallengeHandler: Boolean = true, setAsNetworkAuthenticationChallengeHandler: Boolean = true): AuthenticatorState

Handles authentication challenges and exposes state for the Authenticator to display to the user.

completeBrowserAuthenticationChallenge

fun AuthenticatorState.completeBrowserAuthenticationChallenge(intent: Intent?)

Completes the current browser-based authentication challenge for the AuthenticatorState.

completeOAuthSignIn

fun AuthenticatorState.~~completeOAuthSignIn~~(intent: Intent?)

Completes the current AuthenticatorState.pendingOAuthUserSignIn with data from the provided intent.

DialogAuthenticator

@Composable

fun DialogAuthenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier)

@Composable

fun ~~DialogAuthenticator~~(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingOAuthUserSignIn: (OAuthUserSignIn) -> Unit? = null)

@JvmName(name = "DialogAuthenticatorWithBrowserAuthenticationChallenge")

@Composable

fun DialogAuthenticator(authenticatorState: AuthenticatorState, modifier: Modifier = Modifier, onPendingBrowserAuthenticationChallenge: (BrowserAuthenticationChallenge) -> Unit)

Displays appropriate Authentication UI when an authentication challenge is issued.

launchCustomTabs

fun Activity.~~launchCustomTabs~~(pendingSignIn: OAuthUserSignIn?)

Launches the custom tabs activity with the provided authorize URL. The resulting intent will launch using an Incognito tab if the pendingSignIn's OAuthUserConfiguration.preferPrivateWebBrowserSession is true.

fun Activity.launchCustomTabs(pendingBrowserAuthenticationChallenge: BrowserAuthenticationChallenge)

Launches the custom tabs activity with the provided browser authentication challenge.

signOut

suspend fun AuthenticationManager.~~signOut~~()

Revokes OAuth tokens and removes all credentials from the AuthenticationManager.arcGISCredentialStore and AuthenticationManager.networkCredentialStore.

UsernamePasswordAuthenticator

@Composable

fun ~~UsernamePasswordAuthenticator~~(usernamePasswordChallenge: UsernamePasswordChallenge, modifier: Modifier = Modifier)

Displays a username and password prompt to the user.