Hitachi

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


4.18 ユーザの一覧を取得する

対象のストレージシステムに登録されているユーザ情報の一覧を取得します。

実行権限

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

リクエストライン

GET <ベースURL>/v1/objects/storages/<ストレージデバイスID>/users

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

なし。

ボディ

なし。

レスポンスメッセージ

ボディ
{
  "data": [
    {
      "userObjectId": "devUser",
      "userId": "devUser",
      "authentication": "local",
      "userGroupNames": [
        "Audit Log Administrator (View Only) User Group",
        "Storage Administrator (View & Modify) User Group"
      ],
      "isBuiltIn": false,
      "isAccountStatus": true
    },
    {
      "userObjectId": "adminUser",
      "userId": "adminUser",
      "authentication": "local",
      "userGroupNames": [
        "Administrator User Group"
      ],
      "isBuiltIn": false,
      "isAccountStatus": true
    }
  ]
}

属性

説明

userObjectId

string

ユーザIDのオブジェクトID

ユーザIDがRFC3986 に定められた予約文字を含む場合、エンコードされた文字列が出力されます。

userId

string

ユーザID

userGroupNames

string[]

ユーザグループ名

isBuiltIn

boolean

ビルトインユーザアカウントかどうか

  • true:ビルトインユーザアカウント

  • false:ユーザが作成したアカウント

isAccountStatus

boolean

ユーザアカウントの状態
  • true:ユーザアカウントが有効

  • false:ユーザアカウントが無効

authentication

string

認証の設定

  • local:ストレージシステムで認証

  • external:外部認証サーバで認証

ステータスコード

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

コード例

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