createApiKey
FunctioncreateApiKey(requestOptions: ICreateApiKeyOptions): Promise<IApiKeyResponse>
Used to register an API key. See the security and authentication for more information about API key.
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: [Privileges.Geocode, Privileges.FeatureReport],
authentication: authSession
}).then((registeredAPIKey: IApiKeyResponse) => {
// => {apiKey: "xyz_key", item: {tags: ["xyz_tag1", "xyz_tag2"], ...}, ...}
}).catch(e => {
// => an exception object
});
Parameters
Parameter | Type | Notes |
---|---|---|
request | ICreateApiKeyOptions | Options for |
Returns
Promise<IApiKeyResponse>
A Promise that will resolve to an IApiKeyResponse
object representing the newly registered API key.