ログイン処理を行う
ユーザー名とパスワードをリクエストのパラメーターとして受け取り、ログイン処理を行ない、ログイン認証情報をレスポンスとして返すAPIです。
API名
UtilLogin
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
| login_name/text() | xsd:string | 1 | ログイン名 |
| password/text() | xsd:string | 1 | パスワード |
リクエスト例
<parameters> <login_name>Administrator</login_name> <password>cybozu</password> </parameters>
レスポンス
API名とレスポンスの要素名が異なるためご注意ください。
| パラメーター名 | 型 | パラメーター数 | 説明 |
| login_name/text() | xsd:string | 1 | ログイン名 |
| status/text() | xsd:string | 1 | ログイン情報を表す文字列です。 このAPIを利用した場合、「Login」が挿入されています。 |
| cookie/text() | xsd:string | 1 | 認証情報を持つCookie値 |
レスポンス例
<returns> <login_name>Administrator</login_name> <status>Login</status> <cookie> CBSESSID=C735B4069ccf104Ce0f2bf12a7cc62f115db9e676f6e72f2; path=/ </cookie> </returns>
エラー
パッケージ版 Garoon バージョン 3.0.0以降
| エラー番号 | 説明 |
| FW00007 | パスワードまたはログイン名に誤りがある場合 |
クラウド版 Garoon
| エラー番号 | 説明 |
| CB_PE01 | パスワードの有効期限切れ |
| CB_PL01 | パッケージ版移行直後のログインで発生 |
| CB_US02 | アカウントロック |
| SLASH_IL06 | セキュアアクセスの証明書がログインを試行したユーザーのものでない |
| SLASH_LO02 | 認証情報が間違っている |
| SLASH_PA02 | 「管理者が設定した仮パスワードの変更をユーザーに要求する」の設定の影響 |
※2014年7月13日のアップデート後よりクラウド版 Garoonのエラーメッセージは上記のように変更されます。アップデート前はパッケージ版 バージョン 3.0.0以降のGaroonと同様です。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。