Skip to content

Interface

Options for the ArcGISIdentityManager constructor.

Properties

PropertyTypeNotes
clientIdstring

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.

passwordstring

Password for this user. Used in CLI apps where users cannot do OAuth 2.0.

portalstring

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.

providerAuthenticationProvider

ArcGIS Authentication is used by default. Specifying an alternative will take users directly to the corresponding provider's OAuth page.

redirectUristring

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.

refererstring

The referer to use when getting the token with .signIn()

refreshTokenstring

OAuth 2.0 refresh token.

refreshTokenExpiresDate

Expiration date of the refreshToken

serverstring

An unfederated ArcGIS Server instance known to recognize credentials supplied manually.

sslboolean

This value is set to true automatically if the ArcGIS Organization requires that requests be made over https.

stateIOAuthState

The OAuth 2.0 state object that was provided when the oAuth 2.0 process was initiated.

tokenstring

OAuth 2.0 access token.

tokenDurationnumber

Duration of requested token validity in minutes. Used when requesting tokens with username and password or when validating the identity of unknown servers. Defaults to two weeks.

tokenExpiresDate

Expiration date for the token

usernamestring

The authenticated user's username. Guaranteed to be unique across ArcGIS Online or your instance of ArcGIS Enterprise.

clientId

optional
Interface Property

password

optional
Interface Property

portal

optional
Interface Property

provider

optional
Interface Property

redirectUri

optional
Interface Property

referer

optional
Interface Property

refreshToken

optional
Interface Property

refreshTokenExpires

optional
Interface Property

server

optional
Interface Property

ssl

optional
Interface Property

state

optional
Interface Property

token

optional
Interface Property

tokenDuration

optional
Interface Property

tokenExpires

optional
Interface Property

username

optional
Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.