API 키 인증

개요

API 키 인증 제공자를 통해 사용자는 생성된 키를 사용하여 로그인할 수 있습니다.

App Services는 다음 두 가지 유형의 API 키를 지원합니다.

• 서버 API 키: App Services CLI, API 또는 UI에서 생성된 서버 사용자와 연결된 API 키입니다.

• 사용자 API 키: 애플리케이션 사용자와 관련된 Realm SDK에서 생성된 API 키입니다.

API 키는 자동으로 만료되지 않습니다.

API 키 인증 활성화

API 키 사용자와 작업하려면 먼저 API 키 인증 제공자를 활성화해야 합니다. API 키 인증 제공자는 구성 옵션이 전혀 없습니다.

{
  "api-key": {
    "name": "api-key",
    "type": "api-key",
    "disabled": false
  }
}

API 키 사용자 객체

모든 App Services 사용자에게는 고유한 메타데이터 객체가 있습니다. 객체는 사용자가 호출한 함수와 요청한 규칙 표현식으로 전달됩니다. API 키 사용자 객체에서 type 필드의 값은 "server"입니다. 예를 들면,

{
  id: "<Unique User ID>",
  type: "server",
  data: <user data object>,
  custom_data: <custom user data object>,
  identities: <array of user identities>,
}

이 필드를 사용하여 요청이 API 키에서 오는지 평가할 수 있습니다.

자세한 내용은 사용자 객체를 참조하세요.

서버 API 키

서버 API 키는 App Services CLI, API 또는 UI 중 하나를 사용하여 서버 측 컨텍스트에서 생성합니다. 서버 API 키를 생성하면 연결된 서버 사용자도 생성됩니다.

외부 애플리케이션과 서비스에 서버 키를 제공해 해당 애플리케이션과 서비스가 App Services에서 직접 인증하도록 허용할 수 있습니다.

최대 100개의 서버 API 키를 앱과 연결할 수 있습니다.

appservices users create --type=api-key

appservices users create --type=api-key \
  --app=<Your App ID> \
  --name=<API Key Name>

사용자 API 키

Realm SDK를 사용해 사용자 API 키를 생성할 수 있습니다. 각 사용자 API 키는 익명이 아닌 단일 사용자와 연결됩니다. 각 사용자는 본인 계정에 최대 20개의 사용자 API 키를 연결할 수 있습니다. 키가 사용자 계정과 연결되면 사용자는 해당 키를 사용해 인증할 수 있습니다. 다음 다이어그램에는 사용자 API 키를 생성해 사용하는 방법이 나와 있습니다.

사용자 API 키를 생성하는 방법을 알아보려면 Realm SDK 문서를 참조하세요.

Realm SDK 예시

API 키 인증을 사용하여 등록 및 로그인하는 방법에 관한 코드 예시는 Realm SDK 설명서를 참조하세요.