カスタムユーザーメタデータの定義

カスタムユーザーデータ構成画面に移動する

左側のナビゲーション メニューで [ App Usersをクリックします。 次に、 User Settingsタブを選択し、 Custom User Dataセクションを見つけます。

カスタムユーザーデータの有効化

Enable Custom User DataトグルをクリックしてOnに設定します。

クリックして拡大します

カスタムユーザーデータコレクションを指定する

アプリケーションのユーザーのカスタム データは、リンクされた MongoDB Atlas クラスターの単一のコレクションに保存する必要があります。 このコレクションからユーザー データを読み取るようにアプリケーションを構成するには、次の値を指定する必要があります。

• Cluster Name: カスタム ユーザー データ コレクションを含む連結された MongoDB クラスターの名前。

• Database Name: カスタムユーザーデータコレクションを含む MongoDB database の名前。

• Collection Name: カスタム ユーザー データが含まれる MongoDB コレクションの名前。

クリックして拡大します

ユーザー ID フィールドの指定

カスタムユーザーデータコレクション内のすべてのドキュメントには、特定のアプリケーションユーザーにマッピングする フィールドがあります。 フィールドは、そのObjectIdを表す ObjectID または string タイプである必要があります。 このフィールドは、ユーザーにマッピングするすべてのドキュメントに存在する必要があります。

User ID Field入力で各ユーザーの ID を含むフィールドの名前を指定します。

ユーザー作成関数の定義（任意）

ユーザー作成関数を使用する場合は、インライン エディターで定義するか、既存の関数を名前で参照します。

更新されたアプリケーションの配置

カスタム ユーザー データ コレクションを構成したら、アプリケーションをデプロイすることで、カスタム ユーザー データをクライアント アプリケーションで利用できるようになります。 App Services UI からドラフト アプリケーションを配置するには次の手順に従います。

1. 左側のナビゲーション メニューで [ Deployをクリックします。

2. 配置履歴テーブルで配置案を見つけ、 Review & Deploy Changesをクリックします。

3. 変更の差を確認し、 Deployをクリックします。

アプリケーションが正常に配置されると、App Services によるカスタム データのユーザーとの関連付けが開始されます。 ユーザーがログインすると、App Services はカスタム ユーザー データ コレクションで、指定されたUser ID Fieldにユーザーの ID が含まれるドキュメントを自動的にクエリします。 ドキュメントが一致する場合、App Services はドキュメント内のデータをそのユーザーのユーザー オブジェクトのcustom_dataフィールドに公開します。

アプリの最新バージョンを取得する

appservices を使用してカスタム ユーザー データを定義するには、アプリケーションの構成ファイルのローカル コピーが必要です。

アプリの最新バージョンのローカルコピーを取得するには、次のコマンドを実行します。

appservices pull --remote="<Your App ID>"

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

アプリケーションのユーザーのカスタム データは、リンクされた Atlas クラスターの単一のコレクションに保存する必要があります。 コレクション内のすべてのドキュメントには、記述する App Services ユーザーのユーザー ID を含む特定のフィールドを含める必要があります。

このコレクションからユーザー データを読み取るようにアプリケーションを構成するには、 /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": "<User ID Field Name>",
  "on_user_creation_function_name": "<Function Name>"
}

カスタムユーザーデータ構成の配置

カスタム ユーザー データを構成したら、更新された構成をリモート アプリにプッシュできます。 App Services CLI はプッシュ時に更新をすぐに配置します。

appservices push --remote="<Your App ID>"

認証プロバイダの設定画面に移動する

App Services UI でユーザー メタデータを構成して有効にできます。 構成ページにアクセスする方法は、次のとおりです。

• 左側のナビゲーション メニューで [ Authenticationをクリックします。

• Authentication Providers タブを選択します。

• 設定するメタデータを持つプロバイダーのEDITボタンを押します。

ユーザー メタデータの設定

Google または Facebook

有効にするメタデータ フィールドの横にあるチェックボックスを選択します。

クリックして拡大します

カスタム JWT 認証

IdP がサポートするメタデータ フィールドを指定できます。 Add Fieldボタンを押した後、以下を定義します。

• パス

• フィールド名

• フィールドが任意か必須か

詳細については、「 JSON web tokenメタデータ フィールド 」を参照してください。

クリックして拡大します

アクセスするメタデータを設定したら、 Save Draftボタンを押します。

更新されたアプリケーションの配置

メタデータ構成を更新した後、アプリケーションを配置する必要があります。 App Services UI からドラフト アプリケーションを配置するには次の手順に従います。

1. 左側のナビゲーション メニューで [ Deployをクリックします。

2. 配置履歴テーブルで配置案を見つけ、 Review & Deploy Changesをクリックします。

3. 変更の差を確認し、 Deployをクリックします。

アプリケーションが正常に配置されると、App Services によってメタデータとユーザーの関連付けが開始されます。 ユーザーがログインすると、 App Services requestsは要求されたメタデータにアクセスするためのユーザーの権限を要求します。 ユーザーが承認すると、App Services はそのユーザーのユーザー オブジェクト内のデータを公開します。

アプリの最新バージョンを取得する

appservices を使用してアプリを更新するには、その構成ファイルのローカル コピーが必要です。

アプリの最新バージョンのローカルコピーを取得するには、次のコマンドを実行します。

appservices pull --remote="<Your App ID>"

メタデータ フィールドの構成

アプリの認証プロバイダのメタデータ_フィールドは、 /auth/providers.jsonにあります。 この配列を更新して、認証プロバイダからユーザー メタデータを要求します。

Google または Facebook

この配列は次のようになります。

{ ...other config details...
  "metadata_fields": [
    {
      "required": false,
      "name": "name"
    },
    {
      "required": false,
      "name": "gender"
    }
  ]
}

カスタム JWT 認証

metadata_fields 配列には、追加のプロパティfield_nameがあります。 カスタムJSON web token認証では、name は フィールドへのパスを表します。 field_nameはフィールド名を表します。

{ ...other config details...
  "metadata_fields": [
    {
      "required": true,
      "name": "user.name",
      "field_name": "name"
    },
    {
      "required": false,
      "name": "user.favoriteColor",
      "field_name": "favoriteColor"
    }
  ]
}

カスタムユーザーデータ構成の配置

カスタム ユーザー データを構成したら、更新された構成をリモート アプリにプッシュできます。 App Services CLI はプッシュ時に更新をすぐに配置します。

appservices push --remote="<Your App ID>"

MongoDB Atlas ユーザーの認証

MongoDB Atlas API キー ペアを使用して、管理ユーザー認証エンドポイントを呼び出します。

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

access_tokenは App Services Admin API へのアクセスを許可します。 すべての管理 API リクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

メタデータ フィールドの構成

認証プロバイダを更新エンドポイントに リクエストを送信します。 リクエスト本文で、プロバイダーのmetadata_fieldsを定義します。

次のように、管理API access_token、アプリを含むAtlasプロジェクトの groupId、アプリ内部の appId 16 進string 、および認証プロバイダの _id 値を含めます。

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
    "name": "oauth2-facebook",
    "type": "oauth2-facebook",
    "redirect_uris": ["https://example.com/"],
    "config": {
      "clientId": "<Facebook Client ID>"
    },
    "secret_config": {
      "clientSecret": "<Facebook Client Secret Name>"
    },
    "metadata_fields": [
      { "required": false, "name": "name" },
      { "required": true, "name": "first_name" },
      { "required": true, "name": "last_name" },
      { "required": false, "name": "picture" },
      { "required": false, "name": "gender" },
      { "required": false, "name": "birthday" },
      { "required": false, "name": "min_age" },
      { "required": false, "name": "max_age" },
      { "required": false, "name": "email" }
    ],
    "disabled": false
  }'

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
    "name": "oauth2-google",
    "type": "oauth2-google",
    "redirect_uris": ["https://example.com/"],
    "config": {
      "clientId": "<Google Client ID>"
    },
    "secret_config": {
      "clientSecret": "<Google Client Secret Name>"
    },
    "metadata_fields": [
      { "required": false, "name": "name" },
      { "required": true, "name": "first_name" },
      { "required": true, "name": "last_name" },
      { "required": false, "name": "picture" },
      { "required": false, "name": "gender" },
      { "required": false, "name": "birthday" },
      { "required": false, "name": "min_age" },
      { "required": false, "name": "max_age" },
      { "required": false, "name": "email" }
    ],
    "disabled": false
  }'

curl --request PATCH 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/auth_providers/{providerId}' \
  --header 'Authorization:  Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "_id": "<Provider ID>",
  "name": "custom-token",
  "type": "custom-token",
  "metadata_fields": [
    {
      "required": true,
      "name": "jwt.field.path",
      "field_name": "metadataFieldName"
    }
  ],
  "config": {
    "audience": [],
    "requireAnyAudience": false,
    "signingAlgorithm": "HS256",
    "useJWKURI": false
  },
  "secret_config": {
    "signingKeys": [
      "<JWT Signing Key>"
    ]
  },
  "disabled": true
  }'

プロバイダーのメタデータ フィールドが正常に構成されると、App Services は204応答を返します。