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.
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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"
});

const threeDaysFromToday = new Date();
threeDaysFromToday.setDate(threeDaysFromToday.getDate() + 3);
threeDaysFromToday.setHours(23, 59, 59, 999);

updateApiKey({
  itemId: "xyz_itemId",
  privileges: ["premium:user:geocode:temporary"],
  httpReferrers: [], // httpReferrers will be set to be empty
  authentication: authSession
  generateToken1: true, // optional,generate a new token
  apiToken1ExpirationDate: threeDaysFromToday  // optional, update expiration date
}).then((updatedAPIKey: IApiKeyResponse) => {
  // => {accessToken1: "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.