5.4.1 ログイン
- 機能
-
指定したリクエストに従って,インテリジェント統合管理基盤にログインします。
- 実行権限
-
-
JP1_Console_Admin
-
JP1_Console_Operator
-
JP1_Console_User
-
- APIのバージョン
-
v1
- 形式
-
- リクエスト行
POST /application/component/apiVersion/login/ httpVersion
- リクエストのメッセージボディー
{ "user":ユーザー名, "password":パスワード }
- レスポンスのメッセージボディー
{ "jp1user":JP1ユーザー, "jp1token":JP1認証トークン, "token":Authorizationヘッダー認証トークン, "clientId":クライアントID, "permissions":[ JP1ユーザー権限, … ] }
- パラメーター
-
- user
-
ユーザー名を文字列型で指定します。
- password
-
パスワードを文字列型で指定します。
- ステータスコード
-
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード
メッセージ
説明
200
−
ログインに成功しました。
403
KAJY52001-E
パラメーターが不正なためログインに失敗しました。
KAJY52002-E
認証データが登録されているサーバとの通信に失敗しました。
KAJY52003-E
内部エラーによりログインに失敗しました。
KAJY52004-E
ログイン権限がありません。
メッセージの詳細については,マニュアル「JP1/Integrated Management 3 - Manager メッセージ」を参照してください。
- 戻り値
-
レスポンスヘッダーに次の情報を返却します。
パラメーター名
説明
Set-Cookie
Cookie情報
ステータスコードが200の場合に,レスポンスボディーに次の情報を返却します。
項番
メンバー名
データ型
説明
1
jp1user
文字列
JP1ユーザー名
2
jp1token
文字列
JP1認証トークン
3
token
文字列
Authorizationヘッダー認証用トークン
4
clientId
文字列
クライアントを一意に識別するための識別子
5
permissions
配列
JP1権限文字列の配列
ステータスコードが200以外の場合は,レスポンスのメッセージボディーに次の例外オブジェクトを設定します。
項番
メンバー名
データ型
説明
1
returnCode
文字列
詳細要因コード
- 使用例
-
- ログインAPI呼び出し例
POST http://hostname:xxxxx/im/api/v1/login HTTP/1.1 { "user": "jp1admin", "password":"password" }
- ログインAPI応答例
HTTP/1.1 200 OK Set-Cookie: JSESSIONID=7F2FB43CF4829025661D9E139E911B3B { "jp1user": "jp1admin", "jp1token": "MGFkMmM2M2UwMDE4XzI3XzA4OjI0OjMzX19fX19fX19fX19fX19fX2p wMWFkbWluICAgICAgICAgICAgICAgICAgICAgICAg", "token": "anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMT lmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNB Z0lDQWdJQ0Fn", "clientId": "02157e39-2248-4a0e-8b63-78ffb4296e28", "permissions": { "*": [/*略*/] } }