This documentation is for ArcGIS REST JS 3.x which is no longer maintained. For the latest 4.x documentation see ArcGIS REST JS on the ArcGIS Developer website.

ApiKey

Class
import { ApiKey } from '@esri/arcgis-rest-auth';
const apiKey = new ApiKey("...");

Used to authenticate with API Keys.

Implements

Constructors

Constructor Parameters

Parameter Type Default Notes
options Required IApiKeyOptions

Properties

Property Type Notes
portal string

The current portal the user is authenticated with.

Methods

Method Returns Notes
Promise<string>

Gets a token (the API Key).

getToken

Class Method

Gets a token (the API Key).

  • getToken(url: string) : Promise<string>

Parameters

Parameter Type Default Notes
url Required string

Returns

Promise<string>

Class defined in packages/arcgis-rest-auth/src/ApiKey.ts:22