• esri/identity

Credential

AMD: require(["esri/identity/Credential"], (Credential) => { /* code goes here */ });
ESM: import Credential from "@arcgis/core/identity/Credential";
Class: esri/identity/Credential
Inheritance: Credential Accessor
Since: ArcGIS Maps SDK 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
String

The name of the class.

more details
Accessor
Number

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

more details
Credential
Boolean

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

more details
Credential
Object

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

more details
Credential
String

The server url.

more details
Credential
Boolean

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

more details
Credential
String

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

more details
Credential
String

User associated with the Credential object.

more details
Credential

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK 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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor

Destroys the credential.

more details
Credential
Boolean

Emits an event on the instance.

more details
Credential
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
Credential
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Object

Registers an event handler on the instance.

more details
Credential

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

more details
Credential

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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
emit(type, event){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
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.

removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

Event Overview

Name Type Summary Class

Fires when a credential object is destroyed.

more details
Credential

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.