getApiKey

getApiKey

Function
getApiKey(requestOptionsIGetApiKeyOptions): Promise<IApiKeyResponse>

Used to retrieve the API key with given itemId. See the security and authentication for more information about API key.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import { getApiKey, IApiKeyResponse } from '@esri/arcgis-rest-developer-credentials';
import { ArcGISIdentityManager } from "@esri/arcgis-rest-request";

const authSession: ArcGISIdentityManager = await ArcGISIdentityManager.signIn({
  username: "xyz_usrName",
  password: "xyz_pw"
});

getApiKey({
  itemId: "xyz_itemId",
  authentication: authSession
}).then((retrievedAPIKey: IApiKeyResponse) => {
  // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
IGetApiKeyOptions

Options for getApiKey | getApiKey(), including itemId of which API key to retrieve and an ArcGISIdentityManager authentication session.

Returns 
Promise<IApiKeyResponse>

A Promise that will resolve to an IApiKeyResponse object representing successfully retrieved API key.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close