Credential

Class: esri/identity/Credential
Inheritance: Credential Accessor
Since: ArcGIS API for JavaScript 4.0

Represents a credential object used to access a secure ArcGIS resource.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Number

Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC.

more details
more detailsCredential
Boolean

Indicates whether this credential belongs to a user with admin privileges.

more details
more detailsCredential
Object

The Identity Manager's setOAuthRedirectionHandler returns an object that contains a state property.

more details
more detailsCredential
String

The server url.

more details
more detailsCredential
Boolean

Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol.

more details
more detailsCredential
String

Token generated by the token service using the specified userId and password.

more details
more detailsCredential
String

User associated with the Credential object.

more details
more detailsCredential

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

expiresNumber

Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC.

See also:

isAdminBoolean

Indicates whether this credential belongs to a user with admin privileges.

oAuthStateObject

The Identity Manager's setOAuthRedirectionHandler returns an object that contains a state property. This information is returned for this property.

serverString

The server url.

Indicates whether the resources accessed using this credential should be fetched over HTTPS protocol.

tokenString

Token generated by the token service using the specified userId and password.

userIdString

User associated with the Credential object.

Method Overview

NameReturn TypeSummaryClass

Destroys the credential.

more details
more detailsCredential

Generates a new token and updates the Credential's token property with the newly acquired token.

more details
more detailsCredential

Method Details

destroy()

Destroys the credential. When the credential is destroyed, you should remove any map layers that are using this credential.

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

NameTypeSummaryClass

Fires when a credential object is destroyed.

more details
more detailsCredential

Fires when the token associated with the credential is updated or changed.

more details
more detailsCredential

Event Details

destroy

Fires when a credential object is destroyed. After the credential is destroyed, remove any map layers that use this credential.

token-change

Fires when the token associated with the credential is updated or changed.

API Reference search results

NameTypeModule

There were no match results from your search criteria.