Docs Menu

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

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

GET /orgs/{ORG-ID}/users
Parameter
必須/オプション
説明

ORG-ID

必須。

The unique identifier for the 組織 whose user information you want to retrieve.

フィールド
必須/オプション
説明

pageNum

任意。

The page to return.

デフォルトは 1 です。

itemsPerPage

任意。

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

デフォルトは 100 です。

envelope

任意。

A boolean that specifies whether or not to wrap the response in an envelope.

デフォルトは false です。

pretty

任意

A boolean that specifies whether or not to return a "pretty-printed" JSON document.

デフォルトは false です。

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

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

An array of documents, each representing one Organization user.

名前
説明

country

The country where the user lives.

emailAddress

The user's email address.

firstName

The user's first name.

lastName

ID of the Ops Manager project the user belongs to.

id

The user's id.

links

One or more links to sub-resources and/or related resources.

mobileNumber

The user's mobile phone number.

username

The username for authenticating to MongoDB.

roles

An array of the user's roles within the Organization and for each Project to which the user belongs.

roles.{ENTITY-ID}

{ENTITY-ID}は、このロールが適用される組織またはプロジェクトを表します。 可能な値はorgIdまたはgroupIdです。

roles.roleName

The name of the role. The users resource returns all the roles the user has in either Ops Manager or MongoDB Atlas. Possible values are:

  • 組織ロール

    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

An array of the team ids for the organization.

An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See リンク for more information.

The total number of items in the result set. This value may be higher than the number of objects in the results array if the entire result set is paginated.

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
}