Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド


4.14 ユーザグループの設定を変更する

指定したユーザグループのユーザグループIDやロールを設定します。
メモ

REST API を実行するユーザが、対象ストレージシステムのリソースをREST API でロックしている場合、このAPIは実行できません。その場合は、ロックを解除してから実行してください。

実行権限

セキュリティ管理者(参照・編集)

リクエストライン

PUT <ベースURL>/v1/objects/storages/<ストレージデバイスID>/user-groups/<オブジェクトID

このAPIはPATCHメソッドでも実行できます。

リクエストメッセージ

オブジェクトID

ユーザグループの情報取得で取得したuserGroupObjectIdの値を指定します。

属性

説明

userGroupObjectId

string

(必須)ユーザグループIDのオブジェクトID

大文字と小文字を区別します。

クエリパラメータ

なし。

ボディ

ユーザグループIDを変更する場合のコード例を次に示します。

{
  "userGroupId":"adminGroup"
}

ロールを変更する場合のコード例を次に示します。

{
  "roleNames":[
    "Storage Administrator (Provisioning)",
    "Storage Administrator (Local Copy)"  
  ]
}

1回のリクエストで属性を1つだけ指定できます。

属性

説明

userGroupId

string

(任意)ユーザグループID

1~64文字で指定します。

hasAllResourceGroup

boolean

(任意)全リソースグループを対象に割り当てるかどうか

roleNamesに指定するロールに次のどれかが含まれている場合は、必ずtrueを指定してください。

  • Audit Log Administrator (View & Modify)

  • Audit Log Administrator (View Only)

  • Security Administrator (View & Modify)

  • Security Administrator (View Only)

  • Support Personnel

  • User Maintenance

どれも含まれていない場合は、必ずfalseを指定してください。

roleNames

string[]

(任意)ロール名

次のロール名を指定します。大文字と小文字を区別します。複数指定する場合はコンマで区切ります。

Storage Administrator (View Only)は必ず指定してください。

  • Audit Log Administrator (View & Modify)

  • Audit Log Administrator (View Only)

  • Security Administrator (View & Modify)

  • Security Administrator (View Only)

  • Storage Administrator (Initial Configuration)

  • Storage Administrator (Local Copy)

  • Storage Administrator (Performance Management)

  • Storage Administrator (Provisioning)

  • Storage Administrator (Remote Copy)

  • Storage Administrator (System Resource Management)

  • Storage Administrator (View Only)

  • Support Personnel

  • User Maintenance

注※:このロールを指定する場合は、必ずhasAllResourceGrouptrueを指定してください。

レスポンスメッセージ

ボディ

ジョブオブジェクトを返します。affectedResources以外の属性については、ジョブオブジェクトの説明を参照してください。

属性

説明

affectedResources

設定を変更したユーザグループのURL

Actionテンプレート

なし。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X PUT https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/user-groups/devGroup