Hitachi

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


4.22 ユーザをユーザグループに登録する

ユーザをユーザグループに登録するには、ユーザグループを指定してユーザオブジェクトに割り当てます。
メモ

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

実行権限

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

リクエストライン

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

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

リクエストメッセージ

オブジェクトID

ユーザの情報取得で取得したuserObjectIdの値を指定します。

属性

説明

userObjectId

string

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

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

クエリパラメータ

なし。

ボディ
{
  "parameters": {
    "userGroupNames": [
      "System User Group"
    ]
  }
}

属性

説明

userGroupNames

string[]

(必須)ユーザグループ名

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

1ユーザが所属できるユーザグループ数の上限は次のとおりです。

  • VSP E シリーズVSP G150、G350、G370、G700、G900VSP F350、F370、F700、F900の場合:8個
  • VSP 5000 シリーズVSP G1000VSP G1500VSP F1500の場合:8個
  • VSP G100、G200、G400、G600、G800VSP F400、F600、F800の場合:1個

レスポンスメッセージ

ボディ

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

属性

説明

affectedResources

ユーザグループに登録したユーザのURL

Actionテンプレート

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/users/<オブジェクトID>/actions/add-user-group

ステータスコード

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

コード例

Actionテンプレートを取得する場合

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/users/devUser/actions/add-user-group

Actionテンプレートを取得してリクエストを実行する場合

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" --data-binary @./InputParameters.json -X PUT https://192.0.2.100:23451/ConfigurationManager/v1/objects/storages/836000123456/users/devUser/actions/add-user-group/invoke