IArcGISIdentityManagerOptions
Interface
Options for the ArcGISIdentityManager
constructor.
Properties
Property | Type | Notes |
---|---|---|
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 | |
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 | OAuth 2.0 refresh token. | |
Date | Expiration date of the | |
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 | |
Date | Expiration date for the | |
string | The authenticated user's username. Guaranteed to be unique across ArcGIS Online or your instance of ArcGIS Enterprise. |
clientId optional
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.
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.
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.