Interface
Options for the ArcGISIdentityManager constructor.
Properties
| Property | Type | Notes |
|---|---|---|
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 | string | Password for this user. Used in CLI apps where users cannot do OAuth 2.0. |
portal | string | The ArcGIS Online or ArcGIS Enterprise portal you want to use for authentication. Defaults to |
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. |
referer | string | The referer to use when getting the token with |
refreshToken | string | OAuth 2.0 refresh token. |
refreshTokenExpires | Date | Expiration date of the |
server | string | An unfederated ArcGIS Server instance known to recognize credentials supplied manually. |
ssl | boolean | This value is set to true automatically if the ArcGIS Organization requires that requests be made over https. |
state | IOAuthState | The OAuth 2.0 state object that was provided when the oAuth 2.0 process was initiated. |
token | string | OAuth 2.0 access token. |
tokenDuration | number | Duration of requested token validity in minutes. Used when requesting tokens with |
tokenExpires | Date | Expiration date for the |
username | string | The authenticated user's username. Guaranteed to be unique across ArcGIS Online or your instance of ArcGIS Enterprise. |
clientId
clientId: stringClient 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
password: stringPassword for this user. Used in CLI apps where users cannot do OAuth 2.0.
portal
portal: stringThe 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
provider: AuthenticationProviderArcGIS Authentication is used by default. Specifying an alternative will take users directly to the corresponding provider's OAuth page.
redirectUri
redirectUri: stringA 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
referer: stringThe referer to use when getting the token with .signIn()
refreshTokenExpires
refreshTokenExpires: DateExpiration date of the refreshToken
server
server: stringAn unfederated ArcGIS Server instance known to recognize credentials supplied manually.
{
server: "https://sampleserver6.arcgisonline.com/arcgis",
token: "SOSlV3v..",
tokenExpires: new Date(1545415669763)
}ssl
ssl: booleanThis value is set to true automatically if the ArcGIS Organization requires that requests be made over https.
state
state: IOAuthStateThe OAuth 2.0 state object that was provided when the oAuth 2.0 process was initiated.