Credential
esri/identity/Credential
Represents a credential object used to access a secure ArcGIS resource.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
Number | Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. more details | more details | Credential | |
Boolean | Indicates that this credential was created to access the ArcGIS REST Admin service. more details | more details | Credential | |
Object | The Identity Manager's setOAuthRedirectionHandler returns an object that contains a | more details | Credential | |
String | The server url. more details | more details | Credential | |
Boolean | Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol. more details | more details | Credential | |
String | Token generated by the token service using the specified userId and password. more details | more details | Credential | |
String | User associated with the Credential object. more details | more details | Credential |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- expires Number
Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC.
- See also:
- isAdmin Boolean
Indicates that this credential was created to access the ArcGIS REST Admin service.
- oAuthState Object
The Identity Manager's setOAuthRedirectionHandler returns an object that contains a
state
property. This information is returned for this property.
- server String
The server url.
- ssl Boolean
Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol.
- token String
Token generated by the token service using the specified userId and password.
- userId String
User associated with the Credential object.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Destroys the credential. more details | more details | Credential | ||
Generates a new token and updates the Credential's token property with the newly acquired token. more details | more details | Credential |
Method Details
- destroy()
Destroys the credential. When the credential is destroyed, you should remove any map layers that are using this credential. Any tokens generated via OAuth will automatically be revoked.
- See also:
- refreshToken()
Generates a new token and updates the Credential's token property with the newly acquired token. Tokens are typically kept valid using a timer that automatically triggers a refresh before the token expires. Use this method in cases where the timer has been delayed or stopped.
Event Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
Fires when a credential object is destroyed. more details | more details | Credential | ||
Fires when the token associated with the credential is updated or changed. more details | more details | Credential |
Event Details
- destroy
Fires when a credential object is destroyed. After the credential is destroyed, remove any map layers that use this credential. Any tokens generated via OAuth will automatically be revoked.
- See also:
- token-change
Fires when the token associated with the credential is updated or changed.