deleteApiKey

deleteApiKey

Function
deleteApiKey(requestOptionsIDeleteApiKeyOption): Promise<IDeleteApiKeyResponse>

Used to delete the API Key with given itemId.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import { deleteApiKey, IDeleteApiKeyResponse } 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"
});

deleteApiKey({
  itemId: "xyz_itemId",
  authentication: authSession
}).then((deletedApiKey: IDeleteApiKeyResponse) => {
  // => {itemId: "xyz_itemId", success: true}
}).catch(e => {
  // => an exception object
});
Parameters
ParameterTypeNotes
requestOptions
IDeleteApiKeyOption

Options for deleteApiKey | deleteApiKey(), including itemId of which API key to be deleted and an ArcGISIdentityManager authentication session.

Returns 
Promise<IDeleteApiKeyResponse>

A Promise that will resolve to an IDeleteApiKeyResponse object representing deletion status.

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