ArcGISIdentityManager

Returns 

Clear the cached user infornation. Usefull to ensure that the most recent user information from AuthenticationManagerBase.getUser is used.

Returns 

For a "Host" app that has embedded other platform apps via iframes, when the host needs to transition routes, it should call ArcGISIdentityManager.disablePostMessageAuth() to remove the event listener and prevent memory leaks

Returns 

For a "Host" app that embeds other platform apps via iframes, after authenticating the user and creating a ArcGISIdentityManager, the app can then enable "post message" style authentication by calling this method.

Internally this adds an event listener on window for the message event

Returns 

Exchanges an unexpired refreshToken for a new one, also updates token and tokenExpires.

Returns 

Returns the proper [credentials] option for fetch for a given domain. See trusted server. Used internally by underlying request methods to add support for specific security considerations.

Returns 

"include" or "same-origin"

Returns information about the currently logged in user's portal. Subsequent calls will not result in additional web traffic.

1
2
3
4
manager.getPortal()
  .then(response => {
    console.log(portal.name); // "City of ..."
  })

Returns 

A Promise that will resolve with the data from the response.

Determines the root of the ArcGIS Server or Portal for a given URL.

Returns 

Gets an appropriate token for the given URL. If portal is ArcGIS Online and the request is to an ArcGIS Online domain token will be used. If the request is to the current portal the current token will also be used. However if the request is to an unknown server we will validate the server with a request to our current portal.

Returns 

Returns information about the currently logged in user. Subsequent calls will not result in additional web traffic.

1
2
3
4
manager.getUser()
  .then(response => {
    console.log(response.role); // "org_admin"
  })

Returns 

A Promise that will resolve with the data from the response.

Returns the username for the currently logged in user. Subsequent calls will not result in additional web traffic. This is also used internally when a username is required for some requests but is not present in the options.

1
2
3
4
manager.getUsername()
  .then(response => {
    console.log(response); // "casey_jones"
  })

Returns 

Manually refreshes the current token and tokenExpires.

Returns 

Serializes the ArcGISIdentityManager instance to a JSON string.

1
2
3
4
5
6
7
// create an ArcGISIdentityManager instance
const serializedString = manager.serialize();
localStorage.setItem("arcgis-identity-manager", serializedString);

// later, you can retrieve the manager from localStorage
const serializedString = localStorage.getItem("arcgis-identity-manager");
const manager = ArcGISIdentityManager.deserialize(serializedString);

Returns 

The serialized JSON string.

Convenience method for ArcGISIdentityManager.destroy for this instance of ArcGISIdentityManager

Returns 

Returns authentication in a format useable in the IdentityManager.registerToken() method in the ArcGIS API for JavaScript.

This method can be used with ArcGISIdentityManager.fromCredential to interop with the ArcGIS API for JavaScript.

1
2
3
require(["esri/id"], (esriId) => {
  esriId.registerToken(manager.toCredential());
})

Returns 

ICredential

Converts the ArcGISIdentityManager instance to a JSON object. This is called when the instance is serialized to JSON with JSON.stringify().

1
2
3
4
5
6
7
8
import { ArcGISIdentityManager } from '@esri/arcgis-rest-request';

const session = ArcGISIdentityManager.fromCredentials({
  clientId: "abc123",
  clientSecret: "••••••"
})

const json = JSON.stringify(session);

Returns 

A plain object representation of the instance.

Update the stored ArcGISIdentityManager.token and ArcGISIdentityManager.tokenExpires properties. This method is used internally when refreshing tokens. You may need to call this if you want update the token with a new token from an external source.

Returns 

Get application access information for the current user see validateAppAccess function for details

Returns 

Begins a new server-based OAuth 2.0 sign in. This will redirect the user to the ArcGIS Online or ArcGIS Enterprise authorization page.

Returns 

Begins a new browser-based OAuth 2.0 sign in. If options.popup is true the authentication window will open in a new tab/window. Otherwise, the user will be redirected to the authorization page in their current tab/window and the function will return undefined.

If popup is true (the default) this method will return a Promise that resolves to an ArcGISIdentityManager instance and you must call ArcGISIdentityManager.completeOAuth2() on the page defined in the redirectUri. Otherwise it will return undefined and the ArcGISIdentityManager.completeOAuth2() method will return a Promise that resolves to an ArcGISIdentityManager instance.

A ArcGISAccessDeniedError error will be thrown if the user denies the request on the authorization screen.

Returns 

Completes a browser-based OAuth 2.0 sign in. If options.popup is true the user will be returned to the previous window and the popup will close. Otherwise a new ArcGISIdentityManager will be returned. You must pass the same values for clientId, popup, portal, and pkce as you used in beginOAuth2().

A ArcGISAccessDeniedError error will be thrown if the user denies the request on the authorization screen.

Returns 

Deserializes a JSON string previously created with ArcGISIdentityManager.serialize to an ArcGISIdentityManager instance.

1
2
3
4
5
6
7
// create an ArcGISIdentityManager instance
const serializedString = manager.serialize();
localStorage.setItem("arcgis-identity-manager", serializedString);

// later, you can retrieve the manager from localStorage
const serializedString = localStorage.getItem("arcgis-identity-manager");
const manager = ArcGISIdentityManager.deserialize(serializedString);

Returns 

Revokes all active tokens for a provided ArcGISIdentityManager. The can be considered the equivalent to signing the user out of your application.

Returns 

Completes the server-based OAuth 2.0 sign in process by exchanging the authorizationCode for a access_token.

Returns 

Translates authentication from the format used in the IdentityManager class in the ArcGIS API for JavaScript.

You will need to call both IdentityManger.findCredential and IdentityManger.findServerInfo to obtain both parameters for this method.

This method can be used with ArcGISIdentityManager.toCredential to interop with the ArcGIS API for JavaScript.

1
2
3
4
5
6
require(["esri/id"], (esriId) => {
  const credential = esriId.findCredential("https://www.arcgis.com/sharing/rest");
  const serverInfo = esriId.findServerInfo("https://www.arcgis.com/sharing/rest");

  const manager = ArcGISIdentityManager.fromCredential(credential, serverInfo);
});

Returns 

ArcGISIdentityManager

Request credentials information from the parent application

When an application is embedded into another application via an IFrame, the embedded app can use window.postMessage to request credentials from the host application. This function wraps that behavior.

The ArcGIS API for Javascript has this built into the Identity Manager as of the 4.19 release.

Note: The parent application will not respond if the embedded app's origin is not:

• the same origin as the parent or *.arcgis.com (JSAPI)
• in the list of valid child origins (REST-JS)

Returns 

Create a ArcGISIdentityManager from an existing token. Useful for when you have a users token from a different authentication system and want to get a ArcGISIdentityManager.

Returns 

Initialize a ArcGISIdentityManager with a user's username and password. This method is intended ONLY for applications without a user interface such as CLI tools..

If possible you should use ArcGISIdentityManager.beginOAuth2 to authenticate users in a browser or ArcGISIdentityManager.authorize for authenticating users with a web server.

Returns