OAuthUserConfiguration
OAuthUserConfiguration =
object
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:12
An OAuth app that users sign in to a portal with (the SDK’s OAuthUserConfiguration). When a
secured resource of the portal challenges, the authenticator opens the portal’s sign-in page in
a browser instead of asking for a username and password.
Properties
Section titled “Properties”clientId
Section titled “clientId”clientId:
string
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:16
The client ID of the OAuth app registered on the portal.
federatedTokenExpirationMinutes?
Section titled “federatedTokenExpirationMinutes?”
optionalfederatedTokenExpirationMinutes?:number
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:37
How long tokens for the portal’s federated servers stay valid, in minutes; the server’s default
when unset. The Kotlin SDK’s federatedTokenExpirationInterval.
portalUrl
Section titled “portalUrl”portalUrl:
string
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:14
The portal to sign in to, e.g. https://www.arcgis.com.
prefersPrivateWebBrowserSession?
Section titled “prefersPrivateWebBrowserSession?”
optionalprefersPrivateWebBrowserSession?:boolean
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:53
Whether the browser keeps the sign-in private: it shares no cookies with other browsing. The
Kotlin SDK’s preferPrivateWebBrowserSession.
Default
Section titled “Default”falseredirectUrl
Section titled “redirectUrl”redirectUrl:
string
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:21
A redirect URL registered on the OAuth app, e.g. my-app://auth. On Android, list it in the
expo-arcgis-toolkit config plugin’s oAuthRedirectUris as well.
refreshTokenExchangeInterval?
Section titled “refreshTokenExchangeInterval?”
optionalrefreshTokenExchangeInterval?:"never"| {minutes:number; }
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:32
How often the refresh token is exchanged for a new one.
Default
Section titled “Default”{ minutes: 1440 }refreshTokenExpirationInterval?
Section titled “refreshTokenExpirationInterval?”
optionalrefreshTokenExpirationInterval?:"default"|"maximum"| {minutes:number; }
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:27
How long the refresh token stays valid: the portal’s default, the longest it allows, or a number of minutes.
Default
Section titled “Default”'default'showCancelButton?
Section titled “showCancelButton?”
optionalshowCancelButton?:boolean
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:42
Whether the sign-in page shows a cancel button.
Default
Section titled “Default”trueuserInterfaceStyle?
Section titled “userInterfaceStyle?”
optionaluserInterfaceStyle?:"unspecified"|"light"|"dark"
Defined in: packages/expo-arcgis-toolkit/src/Authenticator.tsx:47
The sign-in page’s appearance.
Default
Section titled “Default”'unspecified'