すべての組織ユーザーを取得
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
構文
GET /orgs/{ORG-ID}/users
リクエスト パス パラメーター
Parameter | 必須/オプション | 説明 |
|---|---|---|
ORG-ID | 必須。 | ユーザー情報を取得する組織の一意の識別子。 |
リクエスト クエリ パラメータ
フィールド | 必須/オプション | 説明 |
|---|---|---|
pageNum | 任意。 | 返すページ。 デフォルトは |
itemsPerPage | 任意。 | 1 ページあたりに返す項目の数は最大 500 です。 デフォルトは |
envelope | 任意。 | 応答をエンベロープ でラップするかどうかを指定するブール値。 デフォルトは |
pretty | 任意 | 「pretty-printed」JSON ドキュメントを返すかどうかを指定するブール値。 デフォルトは |
応答要素
クエリ要素envelopeをtrueに設定すると、応答はcontentオブジェクトによってラップされます。
HTTP レスポンスでは、次のオブジェクトを含む JSON document が返されます。
results
それぞれが 1 人の組織ユーザーを表すドキュメントの配列。
名前 | 説明 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
country | ユーザーが住んでいる国。 | ||||||||||||||
emailAddress | ユーザーのメールアドレス。 | ||||||||||||||
firstName | ユーザーの名。 | ||||||||||||||
lastName | ユーザーが属する Cloud Manager プロジェクトの ID。 | ||||||||||||||
id | ユーザーの ID。 | ||||||||||||||
links | サブリソースや関連リソースへの 1 つ以上のリンク。 | ||||||||||||||
mobileNumber | ユーザーの携帯電話番号。 | ||||||||||||||
username | MongoDB への認証に使用するユーザー名。 | ||||||||||||||
roles | 組織内およびユーザーが属する各プロジェクトのユーザーのロールの配列。 | ||||||||||||||
roles.{ENTITY-ID} | {ENTITY-ID}は、このロールが適用される組織またはプロジェクトを表します。 可能な値はorgIdまたはgroupIdです。 | ||||||||||||||
roles.roleName | ロールの名前。
| ||||||||||||||
teamIds | 組織のチーム ID の配列。 |
links
1 つ以上のサブリソースや関連リソース（ リストページ 分割 など）への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。
totalCount
結果セット内の項目の合計数。 結果セット全体がページ分割される場合、この値はresults配列内のオブジェクトの数よりも大きくなる可能性があります。
リクエストの例
リクエスト
curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
応答
{ "links" : [ ... ], "results" : [ { "country": "US", "emailAddress": "someone@example.com", "firstName": "John", "id": "59db8d1d87d9d6420df0613a", "lastName": "Smith", "links": [ ... ], "mobileNumber": "123-456-7890", "roles": [{ "groupId": "59ea02e087d9d636b587a967", "roleName": "GROUP_OWNER" }, { "groupId": "59db8d1d87d9d6420df70902", "roleName": "GROUP_OWNER" }, { "orgId": "59db8d1d87d9d6420df0613f", "roleName": "ORG_OWNER" }], "teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ], "username": "someone@example.com" }, ... ], "totalCount" : 2 }