createApiKey

createApiKey

Function
createApiKey(requestOptionsICreateApiKeyOptions): Promise<IApiKeyResponse>

Used to register an API key. 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
17
18
19
import { createApiKey, 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"
});

createApiKey({
  title: "xyz_title",
  description: "xyz_desc",
  tags: ["xyz_tag1", "xyz_tag2"],
  privileges: ["premium:user:networkanalysis:routing"],
  authentication: authSession
}).then((registeredAPIKey: IApiKeyResponse) => {
  // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
ICreateApiKeyOptions

Options for createApiKey | createApiKey(), including necessary params to register an API key and an ArcGISIdentityManager authentication session.

Returns 
Promise<IApiKeyResponse>

A Promise that will resolve to an IApiKeyResponse object representing the newly registered 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