統合ガイド › Web サービス API リファレンス ガイド › CA AppLogic API の有効なオブジェクト › group オブジェクト › modify メソッド（group オブジェクト）

modify メソッド（group オブジェクト）

説明

ローカル グループの説明またはメンバシップを置換します。

構文

/api/v1/group/modify?group=group&add_principal=add_principal&remove_principal=remove_principal&vdc=controller-name 

引数

group

グループの名前

add_principal

グループに追加するプリンシパルの URL エンコードされた「/」区切りリスト。

たとえば、local:user:api@3tera.com は local%3Auser%3Aapi%403tera.com として渡す必要があります

たとえば、local:user:api@3tera.com /local:user:test@3tera.com は local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com として渡す必要があります

remove_principal

グループから削除するプリンシパルの URL エンコードされた「/」区切りリスト。

たとえば、local:user:api@3tera.com は local%3Auser%3Aapi%403tera.com として渡す必要があります

たとえば、local:user:api@3tera.com /local:user:test@3tera.com は local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com として渡す必要があります

vdc

ターゲットの仮想データ センターの名前

トランザクション タイプ

同期

リクエスト タイプ

GET

例

メンバシップを変更せずに、説明全体を「API GROUP」に置換します

                                                                                                                                   
GET
http://192.168.123.200/api/v1/group/modify?group=mygroup&description=API%20Group&add_principal=&remove_principal=&vdc=mygrid

説明全体を「API GROUP」に置換し、local:user:api@3tera.com をメンバシップに追加し、mygroup から local:user:test@3tera.com を削除します。

GET
http://192.168.123.200/api/v1/group/put?group=mygroup&description=API%20Group&add_principal=local%3Auser%3Aapi%403tera.com&remove_principal=local%3Auser%3Atest%403tera.com&vdc=mygrid

説明全体を「API GROUP」に置換し、mygroup から local:user:api@3tera.com および local:user:test@3tera.com を削除します。

GET
http://192.168.123.200/api/v1/group/put?group=mygroup&description=API%20Group&remove_principal=local%3Auser%3Aapi%403tera.com%2Flocal%3Auser%3Atest%403tera.com&add_principal=&vdc=mygrid

サンプル出力

JSON：

{
   "message" : ""
} 

XML：

<message></message>

HTTP エラー コード

400

エンティティ vdc mygrid が見つかりません
WS_API アプリケーションに設定されていない VDC 名が指定されていました。

400.4

必要な引数（group）がありません。

- 引数 group=group がありません

必要な引数（add_principal）がありません

- 引数 add_principal=add_principal

必要な引数（remove_principal）がありません

- 引数 remove_principal=remove_principal がありません

404.1

エンティティが見つかりません - グループ mygroup は存在しません。

- mygrid に存在しないグループが指定されました。

エンティティが見つかりません - アプリケーション ACL の配置に失敗しました - プリンシパルのデータが無効です - プリンシパルのローカル ユーザ「test@3tera.com」が存在しません。

- 無効なプリンシパルが指定されました

注： この API は WS_API_r6-1.0.6-1 以降で使用できます。