ログイン

ログイン要求を行います。ログインが正常に行われない場合、他のWeb API要求は拒絶されます。

(1) 必要な権限

Login APIの使用に必要な権限はありません。

(2) リクエストURL

http(s)://Domain:xxxx/コンテキスト名/Login

(3) リクエストインタフェース

表1.3 ログインのリクエストインタフェースの項目

項目名

説明

文字

省略

省略値

group_id

グループID（*1）

グループIDを32バイト以内で指定します。

半角

*2

ブランク

user_id

ユーザID（*1）

ユーザIDを32バイト以内で指定します。

半角

*2

ブランク

passwd

パスワード

パスワードを99バイト以内で指定します。

半角

*2

ブランク

login_type

ログイン方法

ログイン時の認証方法を指定します。

0

ID／パスワード

1

クライアント証明書

2

ID／パスワード+クライアント証明書

半角

*2

ブランク

check_relogin_flag

同一IPアドレスから同一ユーザでログインする場合に、既にログイン済みかをチェックします。

true

既にログイン済みの場合はエラーとする

false

既にログイン済みのセッションを破棄してログインする

半角

○

ブランク

*1

:

以下の条件をすべて満たす場合はエラーになります。

  • group_id（グループID）で指定したグループのauth_available_flag（ID／パスワード認証方法）が“true”（認証サーバを利用する）である。

  • group_id（グループID）で指定したグループが使用する認証サーバ情報のonthefly_flag（ユーザ情報を自動生成するフラグ）が“true”（自動生成する）である。

  • group_id（グループID）で指定したグループの登録ユーザ数がregisterable_user_limit（登録可能ユーザ数）に達している。

  • user_id（ユーザID）で指定したユーザは、指定したグループに登録されていない。

*2

:

Login APIのlogin_typeと、group_idとuser_idで指定されたユーザのユーザ情報のlogin_typeによって、省略可否の組み合わせと動作が変わります。

Login API

ユーザ情報

動作

login_type

group_id、user_id、passwd

login_type

0

いずれか1つ以上を省略

任意

エラー

すべて指定

0

group_id、user_id、passwdで認証

1

エラー

2

エラー

1

すべて省略

0

エラー

1

クライアント証明書で認証

2

エラー

いずれか１つ以上を指定

任意

エラー

2

いずれか１つ以上を省略

任意

エラー

すべて指定

0

エラー

1

エラー

2

group_id、user_id、passwd、およびクライアント証明書で認証

省略

いずれか１つ以上を省略

任意

エラー

すべて指定

0

group_id、user_id、passwdで認証

1

エラー

2

group_id、user_id、passwd、およびクライアント証明書で認証

(4) レスポンスインタフェース

表1.4 ログインのレスポンスインタフェースの項目

項目名

説明

備考

info_group

ログインしたグループのグループ情報

「グループ情報（info_group）」参照

info_user

ログインしたユーザのユーザ情報

「ユーザ情報（info_user）」参照

info_auth

ログインしたユーザの権限情報

「権限グループ情報（info_auth）」参照

info_sysconf

サーバのシステム動作環境情報（ログイン時）

「ログイン時のシステム動作環境情報（info_sysconf）」参照
= 備考 =

パスワードの期限切れ（return_code=2112）の場合、情報取得系のAPIおよびログインユーザ自身のユーザ情報設定（パスワード変更）のみ正常に実行することができます。

 

(c) Saison Information Systems Co., Ltd. 2010