API key

---

List API keys

Get a list of API keys.

const response = await geocore.ApiKey.find({
  groupId: "groupId",
  page: 1,
  limit: 10,
});

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

name	type	data type	description
groupId	optional	string	Company ID to get API keys. If user is company admin, then get the current company keys only
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

Get API key by ID

Get API key by ID.

const response = await geocore.ApiKey.findById(apiKeyId);

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

name	type	data type	description
apiKeyId	required	string	API key ID

Create API key

Create a API key.

const response = await geocore.ApiKey.create({
  groupId: "string",
  description: "string",
});

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

name	type	data type	description
groupId	optional	string	Company ID to create API. If user is company admin, then the current company ID is used
description	optional	string	API key description

Update API key

Update an API key.

const response = await geocore.ApiKey.update(
  apiKeyId,
  {
    description: string,
    isActive: boolean,
    permissions: string[],
  }
);

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

name	type	data type	description
apiKeyId	required	string	API key ID
description	optional	string	API key description
isActive	optional	string	API key active status
permissions	optional	string	API key permissions

Delete API key

Delete an API key.

const response = await geocore.ApiKey.delete(apiKeyId);

Prerequisites

Successfully get the IdToken with companyAdmin or superAdmin access level from login API.

Parameters

name	type	data type	description
apiKeyId	required	string	API key ID