1.2.2 認証トークン

機能

認証トークンの有効を確認

処理概要

指定された認証トークンが有効であるか確認します。
有効でない認証トークンが指定された場合は、401 Unauthorizedで復帰します。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークン	必須	string	query

ステータスコード

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

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

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

レスポンス詳細

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

データを格納するキー名: token
単一のオブジェクトを返却

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

コード	キー	説明	形式
200	token	認証トークン	string
	session_id	セッションID	integer
	user_name	ユーザー名	string
	user_role	ユーザーロール	string
	expires_at	認証トークン有効期限	timestamp
	issued_at	認証トークン生成日時	timestamp

1.2.2.2 POST /v1/auth/tokens

機能

ログインと認証トークン取得

処理概要

ログインして認証トークンを取得します。

生成された認証トークンは、各CSG REST APIの“token”パラメーターに指定してください。
作成された内部認証ユーザーまたは認証サーバのユーザーでログインできます。
同時に存在できるセッション数の上限は100件です。
同一ユーザーでログイン中の場合は、エラー(ステータスコード: 401)を返却します。そのとき、通常のエラー時のレスポンス(キーは“msg_id”と“error”の2つ)に“detail”キーを追加し、競合しているセッションの情報を格納します。詳細は、「1.1.2.2 レスポンス」の「レスポンスボディー」の「エラーが発生した場合」を参照してください。
- user: ユーザー名
- role: ロール
- client_info: クライアントIP
- login_date: ログイン日時
- last_ope_date: 最終操作日時

パラメーター

パラメーター名	説明	指定	形式	タイプ
user_name	ユーザー名を指定します。認証サーバのユーザーでログインする場合は、"ユーザー名@ドメイン名"形式で指定します。使用可能文字: 半角英数字使用可能記号: @!-_. 文字数: 1～512 半角スペースは使用できません。大文字・小文字は区別されます。	必須	string	query
password	パスワードを指定します。使用可能文字: 半角英数字記号文字数: 8～64 半角スペースは使用できません。大文字・小文字は区別されます。	必須	string	query
force	強制ログインするか否かを指定します。選択: [true \| false] “true”を指定すればログイン済みのユーザーで再ログインします。“false”を指定すれば強制ログインしません。省略時は“false”を指定したものとみなします。	任意	boolean	query

パラメーター名

説明

指定

形式

タイプ

user_name

ユーザー名を指定します。
認証サーバのユーザーでログインする場合は、"ユーザー名@ドメイン名"形式で指定します。

使用可能文字: 半角英数字
使用可能記号: @!-_.
文字数: 1～512

半角スペースは使用できません。
大文字・小文字は区別されます。

必須

string

query

password

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

使用可能文字: 半角英数字記号
文字数: 8～64

半角スペースは使用できません。
大文字・小文字は区別されます。

必須

string

query

force

強制ログインするか否かを指定します。

選択: [true | false]

“true”を指定すればログイン済みのユーザーで再ログインします。“false”を指定すれば強制ログインしません。

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

任意

boolean

query

ステータスコード"

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

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

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

レスポンス詳細

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

データを格納するキー名: token
単一のオブジェクトを返却

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

コード	キー	説明	形式
200	token	認証トークン	string
	session_id	セッションID	integer
	user_name	ユーザー名	string
	user_role	ユーザーロール	string
	expires_at	認証トークン有効期限	timestamp
	issued_at	認証トークン生成日時	timestamp

1.2.2.3 DELETE /v1/auth/tokens

機能

ログアウトと認証トークン破棄

処理概要

ログアウトして認証トークンを破棄します。

注意

CSG REST APIによる操作を終了するときは本操作でログアウトしてください。

パラメーター

パラメーター名	説明	指定	形式	タイプ
token	認証トークンの値を指定します。	必須	string	query

ステータスコード

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

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

レスポンス詳細

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

データを格納するキー名: token
単一のオブジェクトを返却

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

コード	キー	説明	形式
200	token	認証トークン	string
	session_id	セッションID	integer
	user_name	ユーザー名	string
	user_role	ユーザーロール	string
	expires_at	認証トークン有効期限	timestamp
	issued_at	認証トークン生成日時	timestamp