ユーザー一覧 非推奨

GET /groups/{groupId}/apps/{appId}/users

確認済みのユーザー アカウントを一覧表示します。

path パラメータ

クエリ パラメータ

  • after string

    前回のページ分割リクエストによって返された最後のユーザーの id

  • sort string

    結果を並べ替えるフィールド名。有効な値はデフォルトの _id のみです。

  • desc ブール値

    true の場合は、降順で並べ替えられた結果を返します。指定されない場合、または false に設定されている場合、結果は昇順で返されます。

応答

  • 200 application/ JSON

    正常に一覧表示されました。

    応答属性の非表示 応答属性の表示 オブジェクト
    • _id string

      一意のユーザー アカウントID

    • identity array[オブジェクト]

      ユーザーアカウントに関連付けられた認証プロバイダID のリスト。

      認証プロバイダからの認証済み ID。これは個々の認証プロバイダー内のユーザー アカウントを表し、そのアカウントを外部認証システムにマッピングします。

      ID 属性を非表示にする ID 属性の表示 オブジェクト
      • id string
      • provider_type string

        値は、anon-userlocal-userpassapi-keyoauth2-appleoauth2-googleoauth2-facebookcustom-token、または custom-function です。

      • provider_id string
    • タイプ string

      ユーザーの種類。ほとんどのユーザーは normal で、特定の人間ユーザーを表しています。api-key プロバイダーを通じて作成されたユーザーは、通常、サーバーからのプログラムによるアクセスに使用されるため、タイプは server です。

      値は normal または server です。

    • created_date integer

      ユーザー アカウントが作成された日時。UNIXエポックからの秒数で表されます。

    • last_authentication_date integer

      ユーザー アカウントが最後にログイン、またはリクエストを認証した日時。UNIXエポックからの秒数で表されます。

    • disabled ブール値

      true の場合、ユーザー アカウントは非アクティブのため、ログインしたり、App Services と交流したりできません。

    • データ オブジェクト

      ユーザーを説明するメタデータ。このフィールドは、ユーザーに関連付けられたすべての認証ID のデータを組み合わせます。正確なフィールド名と値は、ユーザーが認証された認証プロバイダによって異なります。

      例、ユーザーが Google アカウントにメール/パスワード アカウントをリンクしている場合、このオブジェクトには email と、namepicture などの Google のメタデータフィールドが含まれる可能性があります。

/groups/{groupId}/apps/{appId}/users を取得する
curl \
 --request GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
応答の例(200)
[
  {
    "_id": "string",
    "identities": [
      {
        "id": "string",
        "provider_type": "anon-user",
        "provider_id": "string"
      }
    ],
    "type": "normal",
    "creation_date": 42,
    "last_authentication_date": 42,
    "disabled": true,
    "data": {}
  }
]