user.checkAuthentication

説明

object user.checkAuthentication

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

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

パラメータ

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

パラメータ	タイプ	説明
extend	boolean	ユーザーセッションを延長するかどうか。デフォルト値: "true" 値を "false" に設定すると、セッションを延長せずにユーザーセッションをチェックできます。パラメータの動作: - `sessionid` が設定されている場合はサポート
sessionid	string	ユーザーの認証トークン。パラメータの動作: - `token` が設定されていない場合は必須
secret	string	ランダムな32文字の文字列。ユーザーログイン時に生成されます。
token	string	ユーザーのAPIトークン。パラメータの動作: - `sessionid` が設定されていない場合は必須

戻り値

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

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

プロパティ	型	説明
auth_type	integer	ユーザーのデフォルト認証。可能な値の一覧は、認証オブジェクトの`authentication_type`プロパティを参照してください。
debug_mode	integer	ユーザーのデバッグモードが有効か無効か。可能な値の一覧は、ユーザーグループオブジェクトの`debug_mode`プロパティを参照してください。
deprovisioned	boolean	ユーザーが無効化されたユーザーグループに属しているかどうか。
gui_access	string	フロントエンドへのユーザーの認証方法。可能な値の一覧は、ユーザーグループオブジェクトの`gui_access`プロパティを参照してください。
secret	string	ランダムな32文字の文字列。ユーザーログイン時に生成されます。 APIトークンを使用してユーザーセッションを確認した場合、`secret`プロパティは返されません。
sessionid	string	認証トークン。以降のAPIリクエストで使用する必要があります。 APIトークンを使用してユーザーセッションを確認した場合、`sessionid`プロパティは返されません。
type	integer	ユーザータイプ。可能な値の一覧は、ロールオブジェクトの`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 トークンを使用してユーザーセッションを確認し、ユーザーに関する追加情報を返します。