user.checkAuthentication

説明

object user.checkAuthentication

このメソッドは、ユーザーセッションを確認し、延長します。

sessionid パラメータを使用して user.checkAuthentication メソッドを呼び出すと、デフォルトでユーザーセッションが延長されます。

パラメータ

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

パラメータ 型 説明
extend boolean ユーザーセッションを延長するかどうか。

デフォルト値: "true"。
値を "false" に設定すると、延長せずにユーザーセッションを確認できます。

パラメータの動作:
- sessionid が設定されている場合は supported
sessionid string ユーザーの認証トークン。

パラメータの動作:
- token が設定されていない場合は required
token string ユーザーのAPIトークン。

パラメータの動作:
- sessionid が設定されていない場合は required

戻り値

(object) ユーザーに関する情報を含むオブジェクトを返します。

標準のユーザープロパティに加えて、以下の情報が返されます。

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

指定可能な値の一覧については、Authentication object の authentication_type プロパティを参照してください。
debug_mode integer ユーザーに対してデバッグモードが有効か無効か。

指定可能な値の一覧については、User group object の debug_mode プロパティを参照してください。
deprovisioned boolean ユーザーがプロビジョニング解除済みユーザーグループに属しているかどうか。
gui_access string ユーザーのWebインターフェースへの認証方法。

指定可能な値の一覧については、User group object の gui_access プロパティを参照してください。
secret string 32文字のランダムな文字列。ユーザーログイン時に生成されます。

APIトークンを使用してユーザーセッションを確認する場合、secret プロパティは返されません。
sessionid string 認証トークン。以降のAPIリクエストで使用する必要があります。

APIトークンを使用してユーザーセッションを確認する場合、sessionid プロパティは返されません。
type integer ユーザータイプ。

指定可能な値の一覧については、Role object の type プロパティを参照してください。
userip string ユーザーのIPアドレス。

例

認証トークンを使用し認証を確認

ユーザー認証トークンを使用してユーザーセッションを確認し、延長します。また、ユーザーに関する追加情報を返します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2"
    },
    "id": 1
}

Response:

{
    "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",
        "ts_provisioned": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "673b8ba11562a35da902c66cf5c23fa2",
        "secret": "0e329b933e46984e49a5c1051ecd0751"
    },
    "id": 1
}
APIトークンを使用した認証の確認

ユーザーAPIトークンを使用してユーザーセッションを確認し、ユーザーに関する追加情報を返します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "user.checkAuthentication",
    "params": {
        "token": "00aff470e07c12d707e50d98cfe39edef9e6ec349c14728dbdfbc8ddc5ea3eae"
    },
    "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": "1355919338",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "ts_provisioned": "0",
        "debug_mode": 0,
        "deprovisioned": false,
        "gui_access": "1",
        "mfaid": 0,
        "auth_type": 0,
        "type": 3,
        "userip": "127.0.0.1"
    },
    "id": 1
}

ソース

ui/include/classes/api/services/CUser.php の CUser::checkAuthentication()。