IArcGISIdentityManagerOptions

Interface

Options for the ArcGISIdentityManager constructor.

Properties

PropertyTypeNotes
clientId
 optional 
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.

password
 optional 
string

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

portal
 optional 
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
 optional 

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

redirectUri
 optional 
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.

refreshToken
 optional 
string

OAuth 2.0 refresh token.

Date

Expiration date of the refreshToken

server
 optional 
string

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

ssl
 optional 
boolean

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

token
 optional 
string

OAuth 2.0 access token.

tokenDuration
 optional 
number

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.

tokenExpires
 optional 
Date

Expiration date for the token

username
 optional 
string

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

clientId optional

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.

password optional

password: string

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

portal optional

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 optional

provider: AuthenticationProvider

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

redirectUri optional

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.

refreshToken optional

refreshToken: string

OAuth 2.0 refresh token.

refreshTokenExpires optional

refreshTokenExpires: Date

Expiration date of the refreshToken

server optional

server: string

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

Use dark colors for code blocksCopy
     
1
2
3
4
5
{
  server: "https://sampleserver6.arcgisonline.com/arcgis",
  token: "SOSlV3v..",
  tokenExpires: new Date(1545415669763)
}

ssl optional

ssl: boolean

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

token optional

token: string

OAuth 2.0 access token.

tokenDuration optional

tokenDuration: number

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.

tokenExpires optional

tokenExpires: Date

Expiration date for the token

username optional

username: string

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

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