すべての組織ユーザーを取得
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
構文
GET /orgs/{ORG-ID}/users
リクエスト パス パラメーター
Parameter | 必須/オプション | 説明 |
---|---|---|
| 必須。 | The unique identifier for the 組織 whose user information you want to retrieve. |
リクエスト クエリ パラメータ
フィールド | 必須/オプション | 説明 |
---|---|---|
| 任意。 | The page to return. デフォルトは |
| 任意。 | 1 ページあたりに返す項目の数は最大 500 です。 デフォルトは |
| 任意。 | A boolean that specifies whether or not to wrap the response in an envelope. デフォルトは |
| 任意 | A boolean that specifies whether or not to return a "pretty-printed" JSON document. デフォルトは |
応答要素
クエリ要素envelope
をtrue
に設定すると、応答はcontent
オブジェクトによってラップされます。
HTTP レスポンスでは、次のオブジェクトを含む JSON document が返されます。
results
An array of documents, each representing one Organization user.
名前 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
| The country where the user lives. | ||||||||||
| The user's email address. | ||||||||||
| The user's first name. | ||||||||||
| ID of the Ops Manager project the user belongs to. | ||||||||||
| The user's id. | ||||||||||
| One or more links to sub-resources and/or related resources. | ||||||||||
| The user's mobile phone number. | ||||||||||
| The username for authenticating to MongoDB. | ||||||||||
| An array of the user's roles within the Organization and for each Project to which the user belongs. | ||||||||||
|
| ||||||||||
| The name of the role. The
| ||||||||||
| An array of the team ids for the organization. |
links
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.
totalCount
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 }