ページの先頭行へ戻る
Cloud Storage Gateway V1.2.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.3 内部認証ユーザー
前次

1.2.3 内部認証ユーザー

1.2.3.1 GET /v1/auth/users

機能

ユーザー一覧表示

処理概要

作成された内部認証ユーザーの一覧を表示します。

実行ユーザーのロールが“Monitor”の場合は、実行ユーザーの情報のみを表示します。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

フィルターするカラム名を指定します。
“,”で連結して複数のカラムを指定することが可能です。
[例]
id,role

任意

string

query

filter_vals

filter_colsで指定したカラム名に対して、指定順にフィルターの条件を指定します。
数値の場合、“~”で範囲を指定することが可能です。
[例]
1~*,Administrator

任意

string

query

sort_cols

ソートするカラム名を指定します。
[例]
id,role

任意

string

query

sort_vals

sort_colsで指定したカラム名に対して、指定順にソートの条件を指定します。

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

表示するカラム名を指定します。
[例]
id,role

任意

string

query

hide_cols

非表示にするカラム名を指定します。
[例]
id,role

任意

string

query

limit

表示する項目数を指定します。

任意

integer

query

offset

項目の表示開始位置を指定します。

任意

integer

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

表示

形式

列挙型定数

200

id

ユーザーID

Yes

integer

session_id

セッションID

No

integer

name

ユーザー名

Yes

string

role

ユーザーの役割

Yes

enum

Administrator:
すべての操作が
許可されています。

Monitor:
参照操作だけが
許可されています。

mail_address

メールアドレス

No

string

password_changed_at

パスワードの最終設定日時

No

timestamp

description

ユーザーの説明

No

string

1.2.3.2 GET /v1/auth/users/{id}

機能

ユーザー詳細表示

処理概要

ユーザーの詳細を表示します。

実行ユーザーのロールが“Monitor”の場合は、実行ユーザーの情報のみ表示可能です。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

リソースの識別子を指定します。
1つだけ指定可能です。

必須

integer

path

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

200

id

ユーザーID

integer

session_id

セッションID

integer

name

ユーザー名

string

role

ユーザーの役割

enum

Administrator:
すべての操作が
許可されています。

Monitor:
参照操作だけが
許可されています。

mail_address

メールアドレス

string

password_changed_at

パスワードの最終設定日時

timestamp

description

ユーザーの説明

string

1.2.3.3 POST /v1/auth/users

機能

ユーザー作成

処理概要

内部認証ユーザーを作成します。

内部認証ユーザー数の上限は100件です。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

name

ユーザー名を指定します。

  • 使用可能文字: 半角英数字

  • 使用可能記号: !-_.

  • 文字数: 1～64

半角スペースは使用できません。

必須

string

query

password

ユーザーパスワードを指定します。

  • 使用可能文字: 半角英数字

  • 使用可能記号: !"#$&'()*+,-./@[\]^_`{|}~:;<=>?

  • 文字数: 8～64

半角スペースは使用できません。
大文字・小文字は区別されます。
A-Z(英大文字)、a-z(英小文字)、0-9(数字)、記号の中から3種類以上の文字を使用する必要があります。

必須

string

query

role

ユーザーの役割を指定します。

  • 選択: [Administrator | Monitor]

必須

enum

query

mail_address

メールアドレスを指定します。

  • 最大文字数: 63

半角スペースは使用できません。

任意

string

query

description

ユーザーの説明を入力します。

  • 最大文字数: 256

[例]
First User

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

200

id

ユーザーID

integer

session_id

セッションID

integer

name

ユーザー名

string

role

ユーザーの役割

enum

Administrator:
すべての操作が
許可されています。

Monitor:
参照操作だけが
許可されています。

mail_address

メールアドレス

string

password_changed_at

パスワードの最終設定日時

timestamp

description

ユーザーの説明

string

1.2.3.4 PUT /v1/auth/users/{id}

機能

ユーザー変更

処理概要

内部認証ユーザーの登録情報を変更します。

パラメーターで指定された項目のみが変更されます。

変更するパラメーターが何も指定されなかった場合は、何も変更せず200 OKで復帰します。

実行ユーザーのロールが“Monitor”の場合は、自分自身のパスワードとメールアドレスと説明の変更のみ可能です。

操作を行っているユーザー自身と“Administrator”ロールを持つ最後の内部認証ユーザーは、アカウントの無効化を行えません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

ユーザーIDを指定します。

必須

integer

path

password

ユーザーパスワードを指定します。

  • 使用可能文字: 半角英数字

  • 使用可能記号: !"#$&'()*+,-./@[\]^_`{|}~:;<=>?

  • 文字数: 8～64

半角スペースは使用できません。
大文字・小文字は区別されます。
A-Z(英大文字)、a-z(英小文字)、0-9(数字)、記号の中から3種類以上の文字を使用する必要があります。

任意

string

query

role

ユーザーの役割を指定します。

  • 選択: [Administrator | Monitor]

任意

enum

query

mail_address

メールアドレスを指定します。

  • 最大文字数: 63

半角スペースは使用できません。
設定を削除する場合は、空文字列("")を指定します。

任意

string

query

description

ユーザーの説明を入力します。

  • 最大文字数: 256

設定を削除する場合は、空文字列("")を指定します。

[例]
First User

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

200

id

ユーザーID

string

role

ユーザーの役割

enum

Administrator:
すべての操作が
許可されています。

Monitor:
参照操作だけが
許可されています

mail_address

メールアドレス

string

description

ユーザーの説明

string

1.2.3.5 DELETE /v1/auth/users

機能

ユーザー削除

処理概要

内部認証ユーザーを削除します。

ユーザーIDを複数指定した場合、存在するIDのユーザーのみ削除処理を行います。

指定したすべてのユーザーの削除に成功した場合、200 OKで復帰します。

削除不可のユーザーが含まれていた場合、409 Conflictで復帰します。

指定されたユーザーIDがすべて存在しない場合、404 Not Foundで復帰します。

操作を行っているユーザー自身は、削除できません。

実行ユーザーのロールが“Monitor”の場合は、実行できません。

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ids

ユーザーIDを指定します。
“,”(コンマ)区切りで複数指定することができます。

[例]
1,2,3

必須

string

query

force

セッションごとユーザーを削除する場合に指定します。

  • 選択: [true | false]

“true”を指定すればセッションごとユーザーを削除します。“false”を指定すれば削除しません。

省略時は“false”を指定したものとみなします。

[例]
true

任意

string

query

ステータスコード

本REST APIの実行が正常終了した場合は、以下のステータスコードで復帰します。

ステータスコードの詳細は、「ステータスコード」を参照してください。

ステータスコードに応じてメッセージが出力されます。メッセージの詳細は、「第2章 メッセージ」を参照してください。

レスポンス詳細

JSON形式のレスポンスとして表示されます。

表示形式は、「1.1.2.2 レスポンス」の「レスポンスボディー」を参照してください。

コード

キー

説明

形式

列挙型定数

200

ids

削除されたユーザーID(複数存在する場合はコンマ区切りの文字列)

string

force

パラメーターで指定した“true”または“false”

string

前次
Copyright FUJITSU LIMITED 2018-20