Credential

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

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

more detailsCredential
Booleanmore details

Indicates that this credential was created to access the ArcGIS REST Admin service.

more detailsCredential
Objectmore details

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

more detailsCredential
Stringmore details

The server url.

more detailsCredential
Booleanmore details

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

more detailsCredential
Stringmore details

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

more detailsCredential
Stringmore details

User associated with the Credential object.

more detailsCredential

Property Details

declaredClass Stringreadonly inherited
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
more details

Destroys the credential.

more detailsCredential
more details

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

more detailsCredential

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
more details

Fires when a credential object is destroyed.

more details Credential
more details

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

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.