Property Overview

Property Details

dialog Widget

Dialog box widget used to challenge the user for their credentials when the application attempts to access a secure resource. This property is available after the dialog-create event has fired.

tokenValidity Number

The suggested lifetime of the token in minutes.

Default Value:60

useSignInPage Boolean

If your application is on the same domain as *.arcgis.com or ArcGIS Enterprise Server, the IdentityManager will redirect the user to its sign-in page. For instance, let's say an application accesses secure resources from ArcGIS.com or one of its subdomains. Once the application attempts to access this resource, the IdentityManager redirects the user to the ArcGIS.com sign-in page. Once a user successfully logs in, they are redirected back to the application. The same holds true if the application accesses secure resources from ArcGIS Enterprise as the IdentityManager will redirect the user to its sign-in page. If you do not wish for the application to automatically redirect, set this property to false.

Please note that this is not a common scenario. For most, using the OAuth sign-in behavior should handle most of their authentication needs.

Default Value:true

Method Overview

Method Details

checkAppAccess(resUrl, appId){Promise<Object>}

Since: ArcGIS API for JavaScript 4.10

Returns a credential if the user has already signed in to access the given resource and is allowed to do so when using the given application id. In addition, it also returns a boolean, viewOnly, property that indicates whether the app is only viewable. The default is false. If the user has not signed in or does not have access, then the promise will be rejected and its error callback will be called.

This scenario is generally not common unless you are building a licensed app. Also, please note that this method should only be used if your application is on the same domain as *.arcgis.com or ArcGIS Enterprise Server and is only applicable to applications registered as items in the Esri organization.

Parameters:

resUrl String The resource URL.

appId String The registered OAuth application id.

Returns:

Type	Description
Promise<Object>	Resolves to an object which contains the following properties: Property Type Description credential Credential The credential of the user. viewOnly boolean Indicates whether the app is only viewable. Default is false.

checkSignInStatus(resUrl){Promise<Credential>}

Returns the Credential if the user has already signed in to access the given resource. If the user has not signed in, then the promise will be rejected and its error callback will be called.

Parameter:

resUrl String The resource URL.

Returns:

Type	Description
Promise<Credential>	Resolves to the returned credential of the signed-in user.

destroyCredentials()

Destroys all credentials. It is good practice to call this method if working with an application that contains sign-out functionality as any tokens generated via OAuth will automatically be revoked.

emit(type, event){Boolean}

Since: ArcGIS API 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

findCredential(url, userId){Credential}

Returns the Credential for the resource identified by the specified url. Optionally, you can provide a userId to find credentials for a specific user.

Parameters:

url String The URL to a server.

userId String optional The userId for which you want to obtain credentials.

Returns:

Type	Description
Credential	The credential for the resource identified by the specified URL.

findOAuthInfo(url){OAuthInfo}

Returns the OAuthInfo configuration for the passed in Portal server URL.

Parameter:

url String The URL to a Portal.

Returns:

Type	Description
OAuthInfo	The OAuthInfo configuration for the passed in Portal server URL.

Example:

require(["esri/identity/IdentityManager"], function(esriId) {
  var portalURL = "https://host.arcgis.com";
  findOAuthInfo = function (){
    var oAuthInfo = esriId.findOAuthInfo(portalURL)
    console.log(oAuthInfo.toJSON())
  }
});

findServerInfo(url){ServerInfo}

Returns information about the server that is hosting the specified URL.

Parameter:

url String The URL to the server

Returns:

Type	Description
ServerInfo	The ServerInfo configuration for the passed in server URL.

generateToken(serverInfo, userInfo, options){Promise<Object>}

Returns an object containing a token and its expiration time. It is necessary to provide the ServerInfo object that contains a token service URL and a user info object containing username and password. This is a helper method typically called by sub-classes to generate tokens.

Parameters:

Specification:

serverInfo ServerInfo A ServerInfo object that contains a token service URL.

userInfo Object A user info object containing a user name and password.

options Object optional See the table below for the structure of this object. Specification: serverUrl String The server URL. token String The server token. ssl Boolean Indicates if the server requires SSL.

Returns:

Type	Description
Promise<Object>	Resolves to an object containing a token and expiration time.

getCredential(url, options){Promise<Credential>}

Returns a Credential object that can be used to access the secured resource identified by the input URL.

Parameters:

Specification:

url String The URL for the secure resource

options Object optional See the table below for the structure of the options object. Specification: error Error optional Error object returned by the server from a previous attempt to fetch the given URL. oAuthPopupConfirmation Boolean optional Default Value: true If set to false, the user will not be shown a dialog before the OAuth popup window is opened. token String optional Token used for a previous unsuccessful attempt to fetch the given URL.

Returns:

Type	Description
Promise<Credential>	Resolves to an object containing a Credential that can be used to access the secured resource identified by the input URL.

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.

initialize(json)

Call this method during application initialization with the JSON previously obtained from the toJSON() method used to re-hydrate the state of IdentityManager.

Parameter:

json Object The JSON obtained from the toJSON() method.

isBusy(){Boolean}

Indicates if the IdentityManager is busy accepting user input. For example, it returns true if the user has invoked signIn and is waiting for a response.

Returns:

Type	Description
Boolean	Whether IdentityManager is currently accepting user input.

on(type, listener){Object}

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

Parameters:

type String|String[] A event type, or an array of event types, to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can 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);
});

registerOAuthInfos(oAuthInfos)

Registers OAuth 2.0 configurations.

Parameter:

oAuthInfos OAuthInfo[] An array of OAuthInfo objects that defines the OAuth configurations.

Example:

require(["esri/identity/OAuthInfo", "esri/identity/IdentityManager"], function(OAuthInfo, esriId) {
  var oAuthInfo = new OAuthInfo({
    appId: "<registered client id>"
  }); // required parameter
  esriId.registerOAuthInfos([oAuthInfo]);
});

registerServers(serverInfos)

Register secure servers and the token endpoints.

Parameter:

serverInfos ServerInfo[] An array of ServerInfos objects that defines the secure service and token endpoint. The IdentityManager makes its best guess to determine the location of the secure server and token endpoint. Therefore, in most cases calling this method is not necessary. However, if the location of your server or token endpoint is not standard, use this method to register the location.

Example:

require(["esri/identity/ServerInfo", "esri/identity/IdentityManager"], function(ServerInfo, esriId) {
  var serverInfo = new ServerInfo();
  serverInfo.server = "http://sampleserver6.arcgisonline.com";
  serverInfo.tokenServiceUrl = "http://sampleserver6.arcgisonline.com/arcgis/tokens/generateToken";
  serverInfo.hasServer = true;
  esriId.registerServers([serverInfo]);
});

registerToken(properties)

Registers the given OAuth 2.0 access token or ArcGIS Server token with the IdentityManager. See registerOAuthInfos for additional information. The registerToken method is an advanced workflow for pre-registering long-term tokens for when you don't want users to sign in. See also resource-proxy for another workflow to achieve this result.

Once a user logs in, the access token is registered with the IdentityManager. Subsequently, every AJAX request made by the application forwards this token when accessing web maps and other items stored in ArcGIS Online, or resources on your server.

Parameters:

Specification:

properties Object See the table below for the structure of the properties object. Specification: expires Number optional Token expiration time specified as number of milliseconds since 1 January 1970 00:00:00 UTC. server String For ArcGIS Online or Portal, this is https://www.arcgis.com/sharing/rest or similar to https://www.example.com/portal/sharing/rest. For ArcGIS Server this is similar to https://www.example.com/arcgis/rest/services. ssl Boolean optional Set this to true if the user has an ArcGIS Online organizational account and the organization is configured to allow access to resources only through SSL. token String The access token. userId String optional The id of the user who owns the access token.

setOAuthRedirectionHandler(handlerFunction)

Once a user successfully logs in, they are redirected back to the application. Use this method if the application needs to execute custom logic before the page is redirected. The IdentityManager calls the custom handler function with an object containing redirection properties.

Parameter:

handlerFunction handlerCallback When called, the callback passed to setOAuthRedirectionHandler receives an object containing the redirection properties.

Example:

require(["esri/identity/IdentityManager"],
function(esriId)
{
 esriId.setOAuthRedirectionHandler(function(info)
  {
   // Execute custom logic then perform redirect
   window.location = info.authorizeUrl + "?" + ioquery.objectToQuery(info.authorizeParams);
  });
});

setOAuthResponseHash(hash)

Use this method in the popup callback page to pass the token and other values back to the IdentityManager.

Parameter:

hash String The token information in addition to any other values needed to be passed back to the IdentityManager.

setProtocolErrorHandler(handlerFunction)

When accessing secured resources, the IdentityManager may prompt for username and password and send them to the server using a secure connection. Due to potential browser limitations, it may not be possible to establish a secure connection with the server if the application is being run over HTTP protocol. In such cases, the Identity Manager will abort the request to fetch the secured resource. To resolve this issue, configure your web application server with HTTPS support and run the application over HTTPS. This is the recommended solution for production environments. However, for internal development environments that don't have HTTPS support, you can define a protocol error handler that allows the Identity Manager to continue with the process over HTTP protocol.

Parameters:

Specification:

handlerFunction Function The function to call when the protocol is mismatched. Specification: resourceUrl String The secure resource URL. serverInfo ServerInfo ServerInfo object describing the server where the secure resource is hosted.

setRedirectionHandler(handlerFunction)

If your application is on the same domain as *.arcgis.com or ArcGIS Enterprise Server, the IdentityManager will redirect the user to its sign-in page. For instance, let's say an application accesses secure resources from ArcGIS.com or one of its subdomains. Once the application attempts to access this resource, the IdentityManager redirects the user to the ArcGIS.com sign-in page. Once a user successfully logs in, they are redirected back to the application. The same holds true if the application accesses secure resources from ArcGIS Enterprise as the IdentityManager will redirect the user to its sign-in page. Use this method if the application needs to execute custom logic before the page is redirected by creating a custom redirection handler. The IdentityManager calls the custom handler function with an object containing the redirection properties.

Parameters:

Specification:

handlerFunction Function The function passed to setRedirectionHandler receives an object containing redirection properties. These properties are listed in the table below. Specification: resourceUrl String The URL of the secure resource that triggers the redirection to the ArcGIS.com sign-in page. returnUrlParamName String The application URL where the sign-in page redirects after a successful login. To create the return URL, append the application's URL to signInPage as a parameter. The returnUrlParamName contains the name of the parameter. serverInfo ServerInfo The ServerInfo object describing the server where the secure resource is hosted. signInPage String URL of the sign-in page where users will be redirected.

Example:

require(["esri/identity/IdentityManager"], function(esriId)
{
  esriId.setRedirectionHandler(function(info)
  {
  // Execute custom logic then perform redirect
  window.location = info.signInPage "?"
  info.returnUrlParamName "=" window.location.href;
  });
});

toJSON(){Object}

Return properties of this object in JSON format. It can be stored in a cookie or persisted in HTML5 LocalStorage and later used to:

• Initialize the IdentityManager the next time a user opens your application.
• Share the state of the IdentityManager between multiple web pages of your website. This way users will not be asked to sign in repeatedly when they launch your app multiple times or when navigating between multiple web pages in your website.

Returns:

Type	Description
Object	The JSON object representing the IdentityManager instance calling this method.

Type Definitions

handlerCallback(authorizeParams, authorizeUrl, oAuthInfo, resourceUrl, serverInfo)

The callback to execute when setOAuthRedirectionHandler() is called.

Parameters:

authorizeParams Object Object containing authorization parameters used to access the secure service. See the table below describing the properties of this object. Specification: client_id String The application ID of the registered application. response_type String The type of response returned. state String The state parameter passed back as the object in the Credential's oAuthState property. expiration Number The expiration time in minutes. locale String The locale being used. redirect_uri String The redirect URL represents the valid places that a user can be redirected to after a successful sign in.

authorizeUrl String The OAuth 2.0 authorization URL for the portal.

oAuthInfo OAuthInfo A reference to the OAuthInfo object.

resourceUrl String The URL to the accessed resource.

serverInfo ServerInfo The ServerInfo object describing the server where the secure resource is hosted.

Event Overview

{credential: Credential}

Event Details

credential-create

Fires when a credential is created.

Property:

credential Credential The returned credential.

dialog-create

Fires when the IdentityManager dialog is created. This is used to prompt users for their credentials.