1 つのプロジェクトでのチームのロール更新
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}
はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
注意
このエンドポイントは、 LDAP 認証を使用するプロジェクトと互換性がありません。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
構文
PATCH /groups/{PROJECT-ID}/teams/{TEAM-ID}
リクエスト パス パラメーター
リクエスト クエリ パラメータ
クエリ パラメータ | タイプ | 必要性 | 説明 |
---|---|---|---|
envelope | ブール値 | 任意 | デフォルトは |
pretty | ブール値 | 任意 | 「pretty-printed」 JSONドキュメントを返すかどうかを指定するフラグ。 デフォルトは |
リクエスト ボディ パラメータ
文字列の配列を指定します。各stringはチームに追加する 1 つのロールを表します。 チームに 1 つのロールのみを関連付ける場合でも、配列を指定する必要があります。
Body Parameter | タイプ | 必要性 | 説明 |
---|---|---|---|
roleNames | 配列 | 必須 | 指定したチームに割り当てるプロジェクト ロール。 |
応答
応答ドキュメント
レスポンスJSONドキュメントには、 resultオブジェクトの配列、 linkオブジェクトの配列、および取得されたresultオブジェクトの合計数が含まれます。
名前 | タイプ | 説明 |
---|---|---|
results | 配列 | 配列には、 results 埋め込みドキュメントセクションで詳細に説明されている各アイテムに対して 1 つのオブジェクトが含まれます。 |
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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true" \ --data '{ "roleNames": ["GROUP_OWNER"] }'
応答
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": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" }], "results": [{ "links": [{ "href": "https://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/groups/{PROJECT-ID}/teams/{TEAM-ID3}", "rel": "self" }], "roleNames": ["GROUP_OWNER"], "teamId": "{TEAM-ID3}" }], "totalCount": 3 }