Interface
Options for static OAuth 2.0 helper methods on ArcGISIdentityManager .
Properties
| Property | Type | Notes |
|---|---|---|
clientId | string | Client ID of your application. Can be obtained by registering an application on ArcGIS for Developers, ArcGIS Online or on your instance of ArcGIS Enterprise. |
expiration | number | The requested validity in minutes for a refresh token/access token. Defaults to 20160 (2 weeks). |
locale | string | The locale assumed to render the login page. |
pkce | boolean | If |
popup | boolean | Determines whether to open the authorization window in a new tab/window or in the current window. |
popupWindowFeatures | string | The window features passed to window.open() when |
portal | string | The ArcGIS Online or ArcGIS Enterprise portal you want to use for authentication. Defaults to |
provider | AuthenticationProvider | ArcGIS Authentication is used by default. Specifying an alternative will take users directly to the corresponding provider's OAuth page. |
redirectUri | string | A valid URL to redirect to after a user authorizes your application. Can be set on ArcGIS for Developers, ArcGIS Online or on your instance of ArcGIS Enterprise. |
state | string | IOAuthState | Custom value for oAuth 2.0 state. A random identifier will be generated if this is not passed. You may also pass a plain object and the |
style | "" | "light" | "dark" | Sets the color theme of the oAuth 2.0 authorization screen. Will use the system preference or a light theme by default. |
clientId
Interface PropertyclientId: stringClient ID of your application. Can be obtained by registering an application on ArcGIS for Developers, ArcGIS Online or on your instance of ArcGIS Enterprise.
expiration
expiration: numberThe requested validity in minutes for a refresh token/access token. Defaults to 20160 (2 weeks).
When using PKCE or server-based OAuth this will control the duration of the refresh token. In this scenario, access tokens will always have a 30 minute validity.
When using implicit auth ( pkce: false ) in ArcGISIdentityManager.beginOAuth2 , this controls the duration of the access token and no refresh token will be granted.
locale
locale: stringThe locale assumed to render the login page.
This option is only for when building browser-based applications.
pkce
pkce: booleanIf true will use the PKCE oAuth 2.0 extension spec in to authorize the user and obtain a token. A value of false will use the deprecated oAuth 2.0 implicit grant type.
This option is only for when building browser-based applications.
popup
popup: booleanDetermines whether to open the authorization window in a new tab/window or in the current window.
This option is only for when building browser-based applications.
popupWindowFeatures
popupWindowFeatures: stringThe window features passed to window.open() when popup is true. Defaults to height=400,width=600,menubar=no,location=yes,resizable=yes,scrollbars=yes,status=yes
This option is only for when building browser-based applications.
portal
portal: stringThe ArcGIS Online or ArcGIS Enterprise portal you want to use for authentication. Defaults to https://www.arcgis.com/sharing/rest for the ArcGIS Online portal.
provider
provider: AuthenticationProviderArcGIS Authentication is used by default. Specifying an alternative will take users directly to the corresponding provider's OAuth page.
redirectUri
Interface PropertyredirectUri: stringA valid URL to redirect to after a user authorizes your application. Can be set on ArcGIS for Developers, ArcGIS Online or on your instance of ArcGIS Enterprise.
state
state: string | IOAuthStateCustom value for oAuth 2.0 state. A random identifier will be generated if this is not passed. You may also pass a plain object and the id property will be used as the state value. If an object is passed, all properties will be serialized and made available when the ArcGISIdentityManager.completeOAuth2 method is called. If a string is passed, it will be available as the id property and an additional originalUrl property will be added containing the URL of the page that initiated the oAuth 2.0 process.