auth
認証確認(APIキーが有効か否かを確認)するためのエンドポイントです。
| エンドポイント | auth |
| 機能 | 認証確認 |
| 実装バージョン | 2.7.0 |
| 認証 | 有り |
| HTTPメソッド | GET/POST |
パラメータ
| 入力値 | 機能 | 入力値の型 | デフォルト値 |
|---|---|---|---|
| q[api_key] |
パラメータで認証を行う場合に API キーを指定します。 X-API-Key としてリクエストヘッダに API キーを設定した場合は、このパラメータは X-API-Key での認証に失敗した場合にのみ参照されます。 |
String | 指定なし |
レスポンス
| key | value の内容 | value の型 |
|---|---|---|
| success | 認証の成否 | Boolean |
| response | エラー等の補足情報 | Hash |
| login | APIキーに対応するログイン名 | String |
| allow_update | APIキーに対応する更新系APIへのアクセス可否 ※更新系APIはバージョン2.7.0時点では用意されておりません。 |
Boolean |
レスポンス例
認証成功(APIキーが有効)の場合
{
"success": true,
"login": "login_user",
"allow_update": false,
"response": {}
}
認証失敗(APIキーが無効)の場合
{
"success": false,
"response": {
"message": "invalid apikey"
}
}
サンプルコード
※ 実際にサンプルコードを試す場合は、色のついている箇所をご自身の環境に合わせて変更しご利用ください。
サンプルコードを試す場合、変更箇所の「http(s)://hostname/redmine」は、システム設定の「メール通知設定用のURL」を、「apikey」は、VM
APIキー設定画面で登録済みのAPIキーを設定する必要があります。