Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

すべての組織ユーザーを取得

項目一覧

  • 構文
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • 応答要素
  • リクエストの例
  • リクエスト
  • 応答

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/users
Parameter
必須/オプション
説明
ORG-ID
必須。
ユーザー情報を取得する組織の一意の識別子。
フィールド
必須/オプション
説明
pageNum
任意。

返すページ。

デフォルトは 1 です。

itemsPerPage
任意。

1 ページあたりに返す項目の数は最大 500 です。

デフォルトは 100 です。

envelope
任意。
pretty
任意

「pretty-printed」JSON ドキュメントを返すかどうかを指定するブール値。

デフォルトは false です。

クエリ要素envelopetrueに設定すると、応答はcontentオブジェクトによってラップされます。

HTTP レスポンスでは、次のオブジェクトを含む JSON document が返されます。

それぞれが 1 人の組織ユーザーを表すドキュメントの配列。

名前
説明
country
ユーザーが住んでいる国。
emailAddress
ユーザーのメールアドレス。
firstName
ユーザーの名。
lastName
ユーザーが属する MongoDB Ops Manager プロジェクトの ID。
id
ユーザーの ID。
links
サブリソースや関連リソースへの 1 つ以上のリンク。
mobileNumber
ユーザーの携帯電話番号。
username
MongoDB への認証に使用するユーザー名。
roles
組織内およびユーザーが属する各プロジェクトのユーザーのロールの配列。
roles.{ENTITY-ID}
{ENTITY-ID}は、このロールが適用される組織またはプロジェクトを表します。 可能な値はorgIdまたはgroupIdです。
roles.roleName

ロールの名前。 users リソースは、 MongoDB Ops ManagerまたはMongoDB Atlasのいずれかでユーザーが持っているすべてのロールを返します。 可能な値は次のとおりです。

  • 組織ロール

    API のロール値
    ロール
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_READ_ONLY
  • プロジェクト ロール

    グループとプロジェクトは同義語です。

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

teamIds
組織のチーム ID の配列。

1 つ以上のサブリソースや関連リソース( リストページ 分割 など)への リンク を表すドキュメントの配列。詳細については、「リンク」を参照してください。

結果セット内の項目の合計数。 結果セット全体がページ分割される場合、この値は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
}

戻る

組織内のすべてのプロジェクトを取得