updateApiKey

updateApiKey

Function
updateApiKey(requestOptionsIUpdateApiKeyOptions): Promise<IApiKeyResponse>

Used to update an API key.

Notes about privileges and httpReferrers options:

  1. Provided option will override corresponding old option.
  2. Unprovided option will not trigger corresponding option updates.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { updateApiKey, 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"
});

updateApiKey({
  itemId: "xyz_itemId",
  privileges: [Privileges.Geocode],
  httpReferrers: [], // httpReferrers will be set to be empty
  authentication: authSession
}).then((updatedAPIKey: IApiKeyResponse) => {
  // => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
IUpdateApiKeyOptions

Options for updateApiKey | updateApiKey(), including itemId of which API key to be operated on, optional new privileges, optional new httpReferrers and an ArcGISIdentityManager authentication session.

Returns 
Promise<IApiKeyResponse>

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