/ /

/ /

1 つのプロジェクトでのチームのロール更新

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

構文

PATCH /groups/{PROJECT-ID}/teams/{TEAM-ID}

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

Path Parameter	タイプ	必要性	説明
`PROJECT-ID`	string	必須	このチームに関連付けられているプロジェクトの一意の識別子。
`TEAM-ID`	string	必須	ロールを更新するチームのユニーク識別子。

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

クエリパラメータ	タイプ	必要性	説明
`envelope`	ブール値	任意	応答をエンベロープでラップするかどうかを指定するフラグ。デフォルトは `false` です。
`pretty`	ブール値	任意	"pretty-printed" JSONドキュメントを返すかどうかを指定するフラグ。デフォルトは `false` です。

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

文字列の配列を指定します。各stringはチームに追加する 1 つのロールを表します。チームに 1 つのロールのみを関連付ける場合でも、配列を指定する必要があります。

Body Parameter	タイプ	必要性	説明
`roleNames`	配列	必須	指定したチームに割り当てるプロジェクトロール。

応答

応答ドキュメント

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

名前	タイプ	説明
`results`	配列	Array includes one object for each item detailed in the `results` Embedded Document section.
`links`	配列	配列には、サブリソースや関連リソースへの 1 つ以上のリンクが含まれます。 URL 間の関係は、 Web リンク仕様で説明されています。
`totalCount`	数値	結果セット内の項目の合計数の整数。結果セット全体がページ分割される場合は、 results配列内のオブジェクト数よりも大きくなる可能性があります。

`results` embeddedDocument

result配列の各要素は、1 つのチームに対して指定された 1 つのロールのセットです。

Response Parameter	タイプ	説明
`roleNames`	配列	指定された`teamsId`のチームに割り当てられたプロジェクトロール。
`teamsId`	string	リスト内のロールを割り当てられたチームの一意の識別子。

例

リクエスト

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true" \
     --data '{
        "roleNames": ["GROUP_OWNER"]
      }'

応答

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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true&pageNum=1&itemsPerPage=100",
    "rel": "self"
  }],
  "results": [{
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID1}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_OWNER", "GROUP_BACKUP_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_AUTOMATION_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_USER_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_READ_ONLY"],
    "teamId": "{TEAM-ID1}"
  }, {
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID2}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_DATA_ACCESS_ADMIN", "GROUP_READ_ONLY"],
    "teamId": "{TEAM-ID2}"
  }, {
    "links": [{
      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}",
      "rel": "self"
    }],
    "roleNames": ["GROUP_OWNER"],
    "teamId": "{TEAM-ID3}"
  }],
  "totalCount": 3
}

戻る

rename

ユーザーの追加

1 つのプロジェクトでのチームのロール更新

構文

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

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

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

応答

応答ドキュメント

results embeddedDocument

例

リクエスト

応答

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

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

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

`results` embeddedDocument