ApiKeyManager | ArcGIS REST JS

Class

Used to authenticate methods in ArcGIS REST JS with an API keys. The instance of ApiKeyManager can be passed to IRequestOptions.authentication to authenticate requests.

Use dark colors for code blocksCopy
import { ApiKeyManager } from '@esri/arcgis-rest-request';

const apiKey = new ApiKeyManager.fromKey("...");

In most cases however the API key can be passed directly to the IRequestOptions.authentication.

Implements

IAuthenticationManager

Inheritance: ApiKeyManagerAuthenticationManagerBase

Constructors

constructor

Class Constructor

new ApiKeyManager(options: IApiKeyOptions): ApiKeyManager

Parameters

Parameter	Type
`options`	IApiKeyOptions

Returns

ApiKeyManager

Properties

Property	Type	Notes
`portal`	`string`	The current portal the user is authenticated with.

portal

Class Property

Accessors

Accessor	Returns	Notes
`get token()`	`string`	Gets the current access token (the API Key).
`get username()`	`string`	The username of the currently authenticated user.

token

Class Accessor

username

Class Accessor

Methods

Hide inherited methods

Method	Returns	Notes
`clearCachedUserInfo()` inherited	`void`	Clear the cached user infornation. Usefull to ensure that the most recent user information from `AuthenticationManagerBase.getUser` is used.
`getToken(url)`	`Promise<string>`	Gets the current access token (the API Key).
`getUser(requestOptions?)` inherited	`Promise<IUser>`	Returns information about the currently logged in user. Subsequent calls will not result in additional web traffic.
`getUsername()` inherited	`Promise<string>`	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.
`serialize()`	`string`	Serializes the ApiKeyManager instance to a JSON string.
`toJSON()`	`{ portal: string; token: string; type: string; username: string }`	Converts the `ApiKeyManager` instance to a JSON object. This is called when the instance is serialized to JSON with `JSON.stringify()`.
`deserialize(serialized)`	`ApiKeyManager`	Deserializes a JSON string previously created with `ApiKeyManager.deserialize` to an `ApiKeyManager` instance.
`fromKey(apiKey)`	`ApiKeyManager`	The preferred method for creating an instance of `ApiKeyManager`.

clearCachedUserInfo

inherited

Class Method

clearCachedUserInfo(): void

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

Returns

void

Inherited from AuthenticationManagerBase.clearCachedUserInfo

getToken

Class Method

getToken(url: string): Promise<string>

Gets the current access token (the API Key).

Parameters

Parameter	Type
`url`	string

Returns

Promise<string>

getUser

inherited

Class Method

getUser(requestOptions?: IRequestOptions): Promise<IUser>

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

Use dark colors for code blocksCopy
manager.getUser()
  .then(response => {
    console.log(response.role); // "org_admin"
  })

Parameters

Parameter	Type	Notes
`requestOptions`	IRequestOptions	Options for the request. NOTE: `rawResponse` is not supported by this operation.

Returns

Promise<IUser>

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

Inherited from AuthenticationManagerBase.getUser

getUsername

inherited

Class Method

getUsername(): Promise<string>

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.

Use dark colors for code blocksCopy
manager.getUsername()
  .then(response => {
    console.log(response); // "casey_jones"
  })

Returns

Promise<string>

Inherited from AuthenticationManagerBase.getUsername

serialize

Class Method

serialize(): string

Serializes the ApiKeyManager instance to a JSON string.

Use dark colors for code blocksCopy
import { ApiKeyManager } from '@esri/arcgis-rest-request';

const apiKey = new ApiKeyManager.fromKey("...")

localStorage.setItem("apiKey", apiKey.serialize());

Returns

string

The serialized JSON string.

toJSON

Class Method

toJSON(): { portal: string; token: string; type: string; username: string }

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

Use dark colors for code blocksCopy
import { ApiKeyManager } from '@esri/arcgis-rest-request';

const apiKey = new ApiKeyManager.fromKey("...")

const json = JSON.stringify(session);

Returns

{ portal: string; token: string; type: string; username: string }

A plain object representation of the instance.

deserialize

static

Class Method

deserialize(serialized: string): ApiKeyManager

Deserializes a JSON string previously created with ApiKeyManager.deserialize to an ApiKeyManager instance.

Use dark colors for code blocksCopy
import { ApiKeyManager } from '@esri/arcgis-rest-request';

const apiKey = ApiKeyManager.deserialize(localStorage.getItem("apiKey"));

Parameters

Parameter	Type	Notes
`serialized`	string	The serialized JSON string.

Returns

ApiKeyManager

The deserialized ApiKeyManager instance.

fromKey

static

Class Method

fromKey(apiKey: string | IApiKeyOptions): ApiKeyManager

The preferred method for creating an instance of ApiKeyManager.

Parameters

Parameter	Type
`apiKey`	string \| IApiKeyOptions

Returns

ApiKeyManager