Options for static OAuth 2.0 helper methods on ArcGISIdentityManager
.
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 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.
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 popup
is true. Defaults to height=400,width=600,menubar=no,location=yes,resizable=yes,scrollbars=yes,status=yes
portal
string
The 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
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
Custom value for oAuth 2.0 state. A random identifier will be generated if this is not passed.
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: 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.
expirationoptional
Interface Propertyexpiration: number
The 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.
optionalbrowser only
Interface Propertylocale: string
The locale assumed to render the login page.
pkceoptionalbrowser only
Interface Propertypkce: boolean
If 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.
optionalbrowser only
Interface Propertypopup: boolean
Determines whether to open the authorization window in a new tab/window or in the current window.
popupWindowFeaturesoptionalbrowser only
Interface PropertypopupWindowFeatures: string
The 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
optional
Interface Propertyportal: string
The 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.
optional
Interface Propertyprovider: AuthenticationProvider
ArcGIS Authentication is used by default. Specifying an alternative will take users directly to the corresponding provider's OAuth page.
redirectUri Interface PropertyredirectUri: 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.
stateoptional
Interface Propertystate: string
Custom value for oAuth 2.0 state. A random identifier will be generated if this is not passed.
styleoptional
Interface Propertystyle: ""Â |Â "light"Â |Â "dark"
Sets the color theme of the oAuth 2.0 authorization screen. Will use the system preference or a light theme by default.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4