IArcGISIdentityManagerOptions

Interface

Options for the ArcGISIdentityManager constructor.

Properties

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

string

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

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.

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

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.

string

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

string

OAuth 2.0 refresh token.

Date

Expiration date of the refreshToken

string

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

boolean

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

string

OAuth 2.0 access token.

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.

Date

Expiration date for the token

string

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

clientId

optional
Interface Property
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
Interface Property
password: string

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

portal

optional
Interface Property
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
Interface Property
provider: AuthenticationProvider

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

redirectUri

optional
Interface Property
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.

referer

optional
Interface Property
referer: string

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

refreshToken

optional
Interface Property
refreshToken: string

OAuth 2.0 refresh token.

refreshTokenExpires

optional
Interface Property
refreshTokenExpires: Date

Expiration date of the refreshToken

server

optional
Interface Property
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
Interface Property
ssl: boolean

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

token

optional
Interface Property
token: string

OAuth 2.0 access token.

tokenDuration

optional
Interface Property
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
Interface Property
tokenExpires: Date

Expiration date for the token

username

optional
Interface Property
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.