ページの先頭行へ戻る
Cloud Storage Gateway V1.2.0 リファレンスガイド
FUJITSU Software
第1章 CSG REST API > 1.2 CSG REST API一覧 > 1.2.4 ログインセッション
前次

1.2.4 ログインセッション

1.2.4.1 GET /v1/auth/sessions

機能

ログインセッション一覧

処理概要

現在ログイン中の内部認証ユーザー一覧を表示します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

filter_cols

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

任意

string

query

filter_vals

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

任意

string

query

sort_cols

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

任意

string

query

sort_vals

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

  • 昇順: asc

  • 降順: desc

[例]
asc,asc,desc

任意

string

query

show_cols

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

任意

string

query

hide_cols

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

任意

string

query

limit

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

任意

integer

query

offset

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

任意

integer

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

表示

形式

列挙型定数

200

id

セッションID

Yes

integer

user_name

ユーザー名

Yes

string

user_role

ユーザーの役割

Yes

enum

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

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

auth_server_ip_address

認証を行った認証サーバのIPアドレス

No

cidr

connect_ip_address

接続元IPアドレス

No

cidr

final_logged_in_at

最終ログイン日時

No

timestamp

final_operated_at

最終操作日時

No

timestamp

1.2.4.2 GET /v1/auth/sessions/{id}

機能

ログインセッション詳細

処理概要

現在ログイン中の内部認証ユーザー一覧を表示します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

id

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

必須

integer

path

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

200

id

セッションID

integer

user_name

ユーザー名

string

user_role

ユーザーの役割

enum

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

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

auth_server_ip_address

認証を行った認証サーバのIPアドレス

cidr

connect_ip_address

接続元IPアドレス

cidr

final_logged_in_at

最終ログイン日時

timestamp

final_operated_at

最終操作日時

timestamp

1.2.4.3 DELETE /v1/auth/sessions

機能

強制ログアウト

処理概要

指定されたすべてのユーザーを、強制ログアウトします。

セッションIDを複数指定した場合、存在するセッションIDのユーザーのみ強制ログアウト処理を行います。

指定したすべてのセッションの強制ログアウトに成功した場合、200 OKで復帰します。

強制ログアウト不可のセッションが含まれていた場合、409 Conflictで復帰します。

指定されたセッションIDがすべて存在しない場合、404 Not Foundで復帰します。

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

パラメーター

パラメーター名

説明

指定

形式

タイプ

token

認証トークン

必須

string

query

ids

強制ログアウトするユーザーのセッションIDを指定します。
“,”(コンマ)区切りで複数指定することができます。

[例]
1,2,3

必須

string

query

ステータスコード

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

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

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

レスポンス詳細

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

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

コード

キー

説明

形式

列挙型定数

200

ids

強制ログアウトされたユーザーのセッションID(複数存在する場合はコンマ区切りの文字列で表示)

string

前次
Copyright FUJITSU LIMITED 2018-20