ユーザーと認証プロバイダの構成ファイル

項目一覧

認証プロバイダ

構成
カスタムユーザーデータ

Atlas Device Sync、Atlas Edge Server、Data API、HTTPS endpoints は非推奨です。詳細については、の廃止ページを参照してください。

注意

このページでは、レガシー構成ファイル形式について説明します。非推奨の realm-cliを使用している場合にのみ、この情報を使用する必要があります。

App Services CLI を使用してプルする構成ファイル、または UI からエクスポートする構成ファイルには、最新の構成バージョンが使用されます。現在の構成ファイル形式の詳細については、「アプリ構成」を参照してください。

app/
└── auth/
    ├── providers.json
    └── custom_user_data.json

認証プロバイダ

構成

/auth/providers.jsonで認証プロバイダを有効にして構成できます。

構成の各フィールドは、プロバイダータイプの名前であり、そのプロバイダーの構成オブジェクトが含まれています。認証プロバイダの構成は共通の構造を共有しますが、各プロバイダーのタイプでは異なる構成フィールドのセットが使用されます。

Tip

特定のプロバイダーのリファレンスページで、そのプロバイダーの構成に関する詳細情報を確認できます。すべてのプロバイダーのリファレンスページのリストについては、「認証プロバイダ」を参照してください。

/auth/providers.json

{
  "<Provider Name>": {
    "name": "<Provider Name>",
    "type": "<Provider Type>",
    "disabled": <Boolean>,
    "config": {
      "<Configuration Option>": "<Configuration Value>"
    },
    "secret_config": {
      "<Configuration Option>": "<Secret Name>"
    },
    "metadata_fields": [
      {
        "required": <Boolean>,
        "name": "Field Name"
      },
      ...
    ],
    "redirect_uris": ["<Application Redirect URI>", ...]
  },
  ...
}

フィールド	説明
`name` String	認証プロバイダの名前。これは常にプロバイダーの`type`と同じになります。
`type` String	認証プロバイダの種類。有効なオプション: `"anon-user"` 匿名認証用。 `"local-userpass"` で、メール/パスワード認証が行われます。 `"api-key"` （ API キー認証用）。 `"custom-token"` カスタムJSON web token認証用。 `"custom-function"` カスタム機能認証用。 `"oauth2-google"` Google認証用。 `"oauth2-facebook"` Facebook認証用。 `"oauth2-apple"` （ Apple ID認証用）。
`disabled` Boolean	`true`の場合、この認証プロバイダはアプリケーションで有効になっていません。無効にされたプロバイダーの認証情報を使用してログインすることはできません。
`config` Document	認証プロバイダに固有の構成値を含むドキュメント。次のプロバイダー構成には`config`が含まれます。メール/パスワードカスタム JWT カスタム関数 Google Facebook Apple ID
`secret_config` Document	各フィールド名がプロバイダーのプライベート構成フィールドで、各フィールドの値が構成値を保存するシークレットの名前であるドキュメント。次のプロバイダー構成には`redirect_uris`が含まれます。カスタム JWT Google Facebook Apple ID
`metadata_fields` Array<Document>	各ドキュメントがユーザーを説明するメタデータフィールドを定義するドキュメントの配列。このフィールドの有無と各メタデータフィールドドキュメントの正確な形式は、プロバイダーの種類によって異なります。次のプロバイダー構成には`metadata_fields`が含まれます。カスタム JWT Google Facebook
`redirect_uris` Array<String>	Atlas App Services が OAuth 認証を完了した後にユーザーをリダイレクトできる URL のリスト。次のプロバイダー構成には`redirect_uris`が含まれます。 Google Facebook Apple ID

カスタムユーザーデータ

アプリのカスタムユーザーデータコレクションは/auth/custom_user_data.jsonで構成できます。

/auth/custom_user_data.json

{
  "enabled": <Boolean>,
  "mongo_service_name": "<MongoDB Data Source Name>",
  "database_name": "<Database Name>",
  "collection_name": "<Collection Name>",
  "user_id_field": "<Field Name>",
  "on_user_creation_function_name": "<Function Name>"
}

フィールド名	説明
`enabled` Boolean	`true`の場合、App Services は各ユーザーを、カスタムデータを含む指定されたコレクション内のドキュメントに関連付けます。
`mongo_service_name` String	カスタムユーザーデータコレクションを含むデータソースの名前。
`database_name` String	カスタムユーザーデータコレクションを含むデータベースの名前。
`collection_name` String	カスタムユーザーデータが含まれるコレクションの名前。
`user_id_field` String	ドキュメントが記述するアプリケーションユーザーのユーザー ID を含むカスタムユーザーデータドキュメント内のフィールドの名前。
`on_user_creation_function_name` String	ユーザー作成関数の名前。

Atlas アプリケーションサービスとは