[comment]: # translation:outdated

[comment]: # ({19701d17-19701d17})
# user.login

[comment]: # ({/19701d17-19701d17})

[comment]: # ({605bdb59-c647dda4})
### Opis

`string/object user.login(object parameters)`

Ta metoda umożliwia zalogowanie się do API i wygenerowanie tokenu
uwierzytelniającego.

::: notewarning
Podczas korzystania z tej metody należy również wykonać
[user.logout](/manual/api/reference/user/logout), aby zapobiec
generowaniu dużej liczby rekordów otwartych sesji.
:::

::: noteimportant
Ta metoda jest dostępna tylko dla nieuwierzytelnionych użytkowników, którzy nie należą do żadnej [grupy użytkowników](/manual/api/reference/usergroup/object#user-group) z włączonym uwierzytelnianiem wieloskładnikowym.
:::

[comment]: # ({/605bdb59-c647dda4})

[comment]: # ({3f380cc2-68f0a066})
### Parametry

`(object)` Parametry zawierające nazwę użytkownika i hasło.

Metoda akceptuje następujące parametry.

|Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis|
|--|--|------|
|password|string|Hasło użytkownika.<br><br>[Zachowanie parametru](/manual/api/reference_commentary#parameter-behavior):<br>- *wymagany*|
|username|string|Nazwa użytkownika.<br><br>[Zachowanie parametru](/manual/api/reference_commentary#parameter-behavior):<br>- *wymagany*|
|userData|flag|Zwraca informacje o uwierzytelnionym użytkowniku.|

[comment]: # ({/3f380cc2-68f0a066})

[comment]: # ({0a7a68d2-bc924c62})
### Zwracane wartości

`(string/object)` Jeśli używany jest parametr `userData`, zwracany jest obiekt
zawierający informacje o uwierzytelnionym użytkowniku.

Oprócz [standardowych właściwości użytkownika](object#user) zwracane są
następujące informacje:

|Właściwość|[Typ](/manual/api/reference_commentary#data-types)|Opis|
|--|--|------|
|auth\_type|integer|Domyślna metoda uwierzytelniania dla użytkownika.<br><br>Listę możliwych wartości można znaleźć we właściwości `authentication_type` obiektu [Authentication object](/manual/api/reference/authentication/object#authentication-object).|
|debug\_mode|integer|Określa, czy tryb debugowania jest włączony czy wyłączony dla użytkownika.<br><br>Listę możliwych wartości można znaleźć we właściwości `debug_mode` obiektu [User group object](/manual/api/reference/usergroup/object#user-group).|
|deprovisioned|boolean|Określa, czy użytkownik należy do [grupy wycofanych użytkowników](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|string|Metoda uwierzytelniania użytkownika do frontendu.<br><br>Listę możliwych wartości można znaleźć we właściwości `gui_access` obiektu [User group object](/manual/api/reference/usergroup/object#user-group).|
|mfaid|integer|ID [metody MFA](/manual/api/reference/mfa/object), która ma być używana dla użytkownika podczas logowania.<br><br>Zwraca "0", jeśli MFA jest globalnie wyłączone lub wyłączone dla wszystkich grup użytkowników, do których należy użytkownik.|
|secret|string|Losowy ciąg 32 znaków. Jest generowany podczas logowania użytkownika.|
|sessionid|string|Token uwierzytelniający, który musi być używany w kolejnych żądaniach API.|
|type|integer|Typ użytkownika.<br><br>Listę możliwych wartości można znaleźć we właściwości `type` obiektu [Role object](/manual/api/reference/role/object#role).|
|userip|string|Adres IP użytkownika.|

::: notetip
Jeśli użytkownik został pomyślnie uwierzytelniony po jednej
lub większej liczbie nieudanych prób, metoda zwróci bieżące wartości
właściwości `attempt_clock`, `attempt_failed` i `attempt_ip`,
a następnie je zresetuje.
:::

Jeśli parametr `userData` nie jest używany, metoda zwraca token uwierzytelniający wymagany do [uwierzytelniania](/manual/api#authentication).

[comment]: # ({/0a7a68d2-bc924c62})

[comment]: # ({b41637d2-b41637d2})
### Przykłady

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({ce05d68f-46abbe5a})
#### Uwierzytelnianie użytkownika

Uwierzytelnij użytkownika.

[Żądanie](/manual/api#performing-requests):

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

Odpowiedź:

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

[comment]: # ({/ce05d68f-46abbe5a})

[comment]: # ({d81c0c1a-8448c8ab})
#### Żądanie informacji o uwierzytelnionym użytkowniku

Uwierzytelnij i zwróć dodatkowe informacje o użytkowniku.

[Żądanie](/manual/api#performing-requests):

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

Odpowiedź:

```json
{
    "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
}
```

[comment]: # ({/d81c0c1a-8448c8ab})

[comment]: # ({22a14fca-22a14fca})
### Zobacz także

-   [user.logout](logout)

[comment]: # ({/22a14fca-22a14fca})

[comment]: # ({7fd9f53c-7fd9f53c})
### Źródło

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

[comment]: # ({/7fd9f53c-7fd9f53c})