注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/users
Request Parameters
リクエスト パス パラメーター
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
プロジェクトID | string | 必須 | プロジェクトの一意の識別子です。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 |
|---|---|---|---|
flattenTeams | ブール値 | 任意 | 返されるリストに、このプロジェクトでロールが割り当てられたチームに所属するユーザーを含めるかどうかを示すフラグ。 プロジェクトでは、プロジェクトでは、個々のユーザーにはロールが割り当てられていない場合があります。
|
includeOrgUsers | ブール値 | 任意 | 返されるリストに、
デフォルト値は |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答
応答ドキュメント
応答 JSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
|---|---|---|
| 配列 | 配列には、 |
| 配列 | 配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。URL間の関係は、 Web リンク仕様 で説明されています。 |
| 数値 | 結果セット内の項目の合計数の整数。 結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。 |
results embeddedDocument
各結果は 1 人のユーザーです。
名前 | タイプ | 説明 |
|---|---|---|
メールアドレス | string | 返された MongoDB Atlas ユーザーに割り当てられたメールアドレス。 |
名 | string | 返された MongoDB Atlas ユーザーに割り当てられた名。 |
id | string | 返された MongoDB Atlas ユーザーに割り当てられた一意の識別子です。 |
姓 | string | 返された MongoDB Atlas ユーザーに割り当てられた姓。 |
Links | オブジェクト配列 | サブリソースや関連リソースへの 1 つ以上のリンク。応答内のすべての |
役割 | オブジェクト配列 | 返された MongoDB Atlas ユーザーに割り当てられたロール。 |
role.groupId | string | 返された MongoDB Atlas ユーザーが |
role.orgId | string | 返された MongoDB Atlas ユーザーが |
role.roleName | string |
|
username | string | 返された MongoDB Atlas ユーザーに指定された MongoDB Atlas ユーザー名。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=true"
応答例
応答ヘッダー
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
レスポンス本体
{ "links" : [ { "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/ users?pretty=true&pageNum=1&itemsPerPage=100", "rel" : "self" } ], "results" : [ { "emailAddress" : "joe.bloggs@example.com", "firstName" : "Joe", "id" : "{USER-ID}", "lastName" : "Bloggs", "links" : [ { "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}", "rel" : "self" }, { "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}/accessList", "rel" : "http://mms.mongodb.com/accessList" } ], "roles" : [ { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" }, { "groupId" : "{OTHER-PROJECT-ID}", "roleName" : "GROUP_OWNER" } ... ], "username" : "joe.bloggs" }, { "emailAddress" : "jim.bloggs@example.com", "firstName" : "Jim", "id" : "{OTHER-USER-ID}", "lastName" : "Bloggs", "links" : [ { "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}", "rel" : "self" }, { "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}/accessList", "rel" : "http://mms.mongodb.com/accessList" } ], "roles" : [ { "roleName" : "GLOBAL_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" }, { "orgId" : "{ORGANIZATION-ID}", "roleName" : "ORG_READ_ONLY" } ], "username" : "jim.bloggs" } ], "totalCount" : 2 }