Create & Manage User API Keys - Node.js SDK
On this page
Create a User API Key
To create a new user API key, pass a name that's unique among all of the user's API keys to ApiKeyAuth.create().
const user = app.currentUser; const key = await user.apiKeys.create("apiKeyName");
Important
You cannot create a user API key for a server API key or an anonymous user.
Warning
Store the API Key Value
The SDK only returns the value of the user API key when you create it. Make
sure to store the key value securely so that you can use it to log in.
If you lose or do not store the key value there is no way to recover it.
You will need to create a new user API key.
Look up a User API Key
To get an array that lists all of a user's API keys, call ApiKeyAuth.fetchAll().
To find a specific API key, pass the key's _id to
ApiKeyAuth.fetch().
const user = app.currentUser; // List all of a user's keys const keys = await user.apiKeys.fetchAll(); // Get a specific key by its ID const key = await user.apiKeys.fetch("5eb5931548d79bc784adf46e");
Enable or Disable an API Key
To enable or disable a user API key, pass the key's _id to
ApiKeyAuth.enable() or
ApiKeyAuth.disable(). When a key
is disabled, it cannot be used to log in on behalf of the user.
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Enable the User API Key await user.apiKey.enable(keyId); // Disable the User API Key await user.apiKey.disable(keyId);
Delete an API Key
To permanently delete a user API, pass the key's _id to
ApiKeyAuth.delete(). Deleted keys
cannot be recovered.
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Delete the User API Key await user.apiKey.delete(keyId);