Docs Menu
Docs Home
/ /
Atlas Device SDK
/ /

사용자 API 키 생성 및 관리 - Node.js SDK

이 페이지의 내용

  • 사용자 API 키 만들기
  • 사용자 API 키 조회
  • API 키 활성화 또는 비활성화
  • API 키 삭제

사용자 API 키 를 만들려면 사용자의 모든 API 키 중에서 고유한 이름을 ApiKeyAuth.create()에 전달합니다.

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

중요

경고

API 키 값 저장

SDK는 사용자가 생성할 때 사용자 API 키의 값만 반환합니다. 로그인에 사용할 수 있도록 key 값을 안전하게 저장해야 합니다.

key 값을 분실하거나 저장하지 않으면 이를 복구할 수 있는 방법이 없습니다. 새 사용자 API 키를 생성해야 합니다.

사용자의 모든 API 키를 나열하는 배열을 가져오려면 ApiKeyAuth.fetchAll()을 호출합니다.

특정 API 키를 찾으려면 키의 _idApiKeyAuth.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");

사용자 API 키를 활성화하거나 비활성화하려면 키의 _idApiKeyAuth.enable() 또는 ApiKeyAuth.disable() 에 전달합니다. 키가 비활성화되면 사용자를 대신하여 로그인하는 데 사용할 수 없습니다.

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

사용자 API를 영구적으로 삭제하려면 키의 _idApiKeyAuth.delete() 에 전달합니다. 삭제된 키는 복구할 수 없습니다.

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

돌아가기

사용자 ID 연결