Garoon APIドキュメント

ログイン処理を行う

目次

ログイン処理を行う

固定リンクがコピーされました

ユーザー名とパスワードをリクエストのパラメーターとして受け取り、ログイン処理を行い、ログイン認証情報をレスポンスとして返すAPIです。

API名

固定リンクがコピーされました

UtilLogin

利用できるバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエストパラメーター

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
login_name/text() xsd:string 1 ログイン名
password/text() xsd:string 1 パスワード
例
1
2
3
4

<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値
例
1
2
3
4
5
6
7

<returns>
  <login_name>Administrator</login_name>
  <status>Login</status>
  <cookie>
   CBSESSID=C735B4069ccf104Ce0f2bf12a7cc62f115db9e676f6e72f2; path=/
  </cookie>
</returns>

エラー

固定リンクがコピーされました

パッケージ版Garoon 3.0以降
エラー番号 説明
FW00007 パスワードまたはログイン名に誤りがある場合
クラウド版Garoon
エラー番号 説明
CB_PE01 パスワードの有効期限切れ
CB_PL01 パッケージ版移行直後のログインで発生
CB_US02 アカウントロック
SLASH_IL06 セキュアアクセスの証明書がログインを試行したユーザーのものでない
SLASH_LO02 認証情報が間違っている
SLASH_PA02 「管理者が設定した仮パスワードの変更をユーザーに要求する」の設定の影響