モジュール名: auth

機能名 説明
login フローサービスにログインします
logout フローサービスからログアウトします

機能名: login

説明

フローサービスAPIを使用するためにフローサービスにログインします。
各APIを使用する場合は、まず最初にloginを実行します。
そして、実行結果として取得できるセッションIDを、それ以後のAPIリクエストのHTTPヘッダーX-Fs-SessionIdに設定します。
セッションIDの使用方法についてはAPIの実行方法を参照してください。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/auth/login
リクエストパラメーター
パラメーター 必須 説明
user はい フローサービスにログインするためのユーザー名を指定します。
password いいえ パスワードを指定します。
パスワードなしの場合は指定しません。
lifetime いいえ セッションタイムアウト時間を分で指定します。
省略時は30分となります。
リクエスト例
POST /api/auth/login HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 26

user=/guest&password=guest
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

ログインに成功するとセッションIDが返ります。セッションIDの使用方法についてはAPIの実行方法を参照してください。

<result>
	<status>success</status>
	<data>
		<sessionId>F15B47BC1F004DB489BAF1E4CDD0100D</sessionId>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2000 400 Bad Request userパラメーターが存在しなかった場合
2001 403 Forbidden ログインに失敗した場合

▲ このページのトップへ

機能名: logout

説明

フローサービスからログアウトします。

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/api/auth/logout
リクエストパラメーター
パラメーター 必須 説明
sessionId はい ログイン時に取得したセッションIDを指定します。
リクエスト例
POST /api/auth/logout HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Content-Length: 42

sessionId=F15B47BC1F004DB489BAF1E4CDD0100D
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

ログアウトに成功するとログアウトしたセッションIDが返ります。

<result>
	<status>success</status>
	<data>
		<sessionId>F15B47BC1F004DB489BAF1E4CDD0100D</sessionId>
	</data>
</result>
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

エラーコード HTTPステータスコード 説明
2000 400 Bad Request sessionIdパラメーターが存在しなかった場合
2002 404 Not Found sessionIdパラメーターで指定されたセッションが存在しなかった場合

▲ このページのトップへ