チームに割り当てられたすべてのユーザーを取得する

項目一覧

構文

リクエストパスパラメーター
リクエストクエリパラメータ
リクエストボディパラメータ
応答
応答ドキュメント
results embeddedDocument
リクエストの例
応答例
応答ヘッダー
レスポンス本体

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID}はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。このページでは、説明を参照するときに、より一般的な用語のグループを使用します。エンドポイントはドキュメントに記載されているままです。

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

構文

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users

リクエストパスパラメーター

path 要素	必須/オプション	説明
`ORG-ID`	必須	チームに関連付けられている組織の一意の識別子。
`TEAM-ID`	必須	ユーザーメンバーシップを検索するチームの一意の識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print に含めるかどうかを示すフラグ形式。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部の APIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで`envelope : true`を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

リクエストボディパラメータ

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答

応答ドキュメント

レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。

名前	タイプ	説明
`results`	配列	配列には、 `results`埋め込みドキュメントセクションに詳細な項目ごとに 1 つのオブジェクトが含まれます。
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

result配列の各要素は、チームに割り当てられた 1 人のユーザーです。

名前	タイプ	説明
`emailAddress`	string	ユーザーに関連付けられているメールアドレス。
`firstName`	string	ユーザーの名。
`id`	string	チームの一意の識別子。
`lastName`	string	ユーザーの姓。
`links`	オブジェクト配列	サブリソースや関連リソースへの 1 つ以上のリンク。 URL 間の関係タイプについては、 Web リンク仕様で説明されています。。
`roles`	配列	`roles`配列内の各オブジェクトは、関連付けられた`orgId`または`groupId`に対してユーザーが持つ MongoDB Atlas組織ロールを表します。
`roles.orgId`	string	割り当てられた`roles.roleName`組織ロールを持つユーザーが割り当てられた組織の ID。
`roles.groupId`	string	ユーザーが割り当てられたプロジェクトロールを持つプロジェクト`roles.roleName` の ID。
`roles.roleName`	string	指定された`roles.orgId`または`roles.groupId`のユーザーに割り当てられた組織ロール。
`teamsIds`	配列	ユーザーがメンバーである各チームの string ID の配列。
`username`	string	ユーザーに関連付けられたユーザー名。

リクエストの例

curl --user "{username:apiKey}" --digest -i \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true"

応答例

応答ヘッダー

HTTP/1.1 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

HTTP/1.1 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": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
          "rel": "self"
      }
  ],
  "results": [
      {
          "emailAddress": "CloudUser@example.com",
          "firstName": "Cloud",
          "id": "{USER-ID}",
          "lastName": "User",
          "links": [
              {
                  "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}",
                  "rel": "self"
              }
          ],
          "roles": [
              {
                  "groupId": "{PROJECT-ID}",
                  "roleName": "GROUP_OWNER"
              },
              {
                  "orgId": "{ORG-ID}",
                  "roleName": "ORG_OWNER"
              }
          ],
          "teamIds": [
              "{TEAM-ID}"
          ],
          "username": "CloudUser@example.com"
      }
  ],
  "totalCount": 1
}

戻る

名前を使用して 1 つのチームを取得

チームを作成する

注意

構文

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答