Docs Menu
Docs Home
/ /
Administrar usuarios

Crear y gestionar claves API de usuario - Node.js SDK

Para crear un nuevo Clave API de usuario, pase un nombre que sea único entre todas las claves API del usuario a ApiKeyAuth.create().

const user = app.currentUser;
const key = await user.apiKeys.create("apiKeyName");

Importante

No se puede crear una clave API de usuario para una clave API de servidor o un usuario anónimo.

Advertencia

Almacenar el valor de la clave API

El SDK solo devuelve el valor de la clave API del usuario al crearla. Asegúrese de almacenarla. key valor de forma segura para que puedas usarlo para iniciar sesión.

Si pierde o no guarda el valor key, no podrá recuperarlo. Deberá crear una nueva clave API de usuario.

Para obtener una matriz que enumera todas las claves API de un usuario, llame a ApiKeyAuth.fetchAll().

Para encontrar una clave API específica, pase la clave _id a 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");

Para habilitar o deshabilitar una clave API de usuario, pasa el _id de la clave a ApiKeyAuth.enable() o ApiKeyAuth.disable(). Cuando una clave está deshabilitada, no puede usarse para iniciar sesión en nombre del usuario.

// 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);

Para eliminar permanentemente una API de usuario, pase el valor de la clave _id a ApiKeyAuth.delete(). Las claves eliminadas no se pueden recuperar.

// 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);

Volver

Vincular identidades de usuario

En esta página