user.login

説明

string/object user.login(object parameters)

このメソッドは、APIにログインして認証トークンを生成するためのものです。

このメソッドを使用する場合は、多数のオープンセッションレコードの生成を防ぐために、user.logoutも実行する必要があります。

このメソッドは、多要素認証が有効なユーザーグループに属していない未認証ユーザーのみが利用できます。

パラメーター

(object) ユーザー名とパスワードを含むパラメーター。

このメソッドは以下のパラメーターを受け付けます。

パラメーター 型 説明
password string ユーザーパスワード。

パラメーターの動作:
- 必須
username string ユーザー名。

パラメーターの動作:
- 必須
userData flag 認証されたユーザーに関する情報を返します。

戻り値

(string/object) userDataパラメータが使用された場合、認証されたユーザーに関する情報を含むオブジェクトを返します。

標準のユーザー属性に加えて、以下の情報が返されます。

プロパティ タイプ 説明
auth_type integer ユーザーのデフォルト認証。

利用可能な値の一覧は、認証オブジェクトのauthentication_typeプロパティを参照してください。
debug_mode integer ユーザーのデバッグモードが有効か無効か。

利用可能な値の一覧は、ユーザーグループオブジェクトのdebug_modeプロパティを参照してください。
deprovisioned boolean ユーザーが無効化されたユーザーグループに属しているかどうか。
gui_access string フロントエンドへのユーザーの認証方法。

利用可能な値の一覧は、ユーザーグループオブジェクトのgui_accessプロパティを参照してください。
mfaid integer ログイン時にユーザーが使用するMFAメソッドのID。

MFAがグローバルまたはユーザーが属するすべてのユーザーグループで無効化されている場合は「0」を返します。
secret string ランダムな32文字の文字列。ユーザーログイン時に生成されます。
sessionid string 認証トークン。以降のAPIリクエストで使用する必要があります。
type integer ユーザータイプ。

利用可能な値の一覧は、ロールオブジェクトのtypeプロパティを参照してください。
userip string ユーザーのIPアドレス。

1回以上の認証失敗の後にユーザーが正常に認証された場合、このメソッドはattempt_clock、attempt_failed、attempt_ipプロパティの現在値を返し、その後リセットします。

userDataパラメータが使用されていない場合、このメソッドは認証に必要な認証トークンを返します。

例

ユーザーの認証

ユーザーを認証します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": "0424bd59b807674191e7d77572075f33",
    "id": 1
}

認証されたユーザー情報のリクエスト

認証を行い、ユーザーに関する追加情報を返します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix",
        "userData": true
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "userid": "1",
        "username": "Admin",
        "name": "Zabbix",
        "surname": "Administrator",
        "url": "",
        "autologin": "1",
        "autologout": "0",
        "lang": "ru_RU",
        "refresh": "0",
        "theme": "default",
        "attempt_failed": "0",
        "attempt_ip": "127.0.0.1",
        "attempt_clock": "1355919038",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "mfaid": "1",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "5b56eee8be445e98f0bd42b435736e42",
        "secret": "cd0ba923319741c6586f3d866423a8f4"
    },
    "id": 1
}

参照

ソース

CUser::login() in ui/include/classes/api/services/CUser.php.