[comment]: # translation:outdated

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

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

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

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

Šī metode ļauj pieteikties API un ģenerēt autentifikācijas
marķieri.

::: notewarning
Izmantojot šo metodi, jums ir jāizsauc arī
[user.logout](/manual/api/reference/user/logout), lai novērstu
liela skaita atvērtu sesiju ierakstu ģenerēšanu.
:::

::: noteimportant
Šī metode ir pieejama tikai neautentificētiem lietotājiem, kuri nepieder nevienai [lietotāju grupai](/manual/api/reference/usergroup/object#user-group), kurai ir iespējota daudzfaktoru autentifikācija.
:::

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

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

`(object)` Parametri, kas satur lietotāja vārdu un paroli.

Metode pieņem šādus parametrus.

|Parametrs|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|password|string|Lietotāja parole.<br><br>[Parametra darbība](/manual/api/reference_commentary#parameter-behavior):<br>- *obligāts*|
|username|string|Lietotāja vārds.<br><br>[Parametra darbība](/manual/api/reference_commentary#parameter-behavior):<br>- *obligāts*|
|userData|flag|Atgriezt informāciju par autentificēto lietotāju.|

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

[comment]: # ({0a7a68d2-bc924c62})
### Atgrieztās vērtības

`(string/object)` Ja tiek izmantots parametrs `userData`, tiek atgriezts objekts,
kas satur informāciju par autentificēto lietotāju.

Papildus [standarta lietotāja īpašībām](object#user) tiek
atgriezta šāda informācija:

|Īpašība|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|auth\_type|integer|Noklusējuma autentifikācija lietotājam.<br><br>Iespējamo vērtību sarakstu skatiet [Authentication object](/manual/api/reference/authentication/object#authentication-object) īpašībā `authentication_type`.|
|debug\_mode|integer|Vai lietotājam ir iespējots vai atspējots atkļūdošanas režīms.<br><br>Iespējamo vērtību sarakstu skatiet [User group object](/manual/api/reference/usergroup/object#user-group) īpašībā `debug_mode`.|
|deprovisioned|boolean|Vai lietotājs pieder [deprovisioned users group](/manual/web_interface/frontend_sections/users/authentication#configuration).|
|gui\_access|string|Lietotāja autentifikācijas metode lietotāja saskarnei.<br><br>Iespējamo vērtību sarakstu skatiet [User group object](/manual/api/reference/usergroup/object#user-group) īpašībā `gui_access`.|
|mfaid|integer|[MFA method](/manual/api/reference/mfa/object) ID, kas jāizmanto lietotājam pieteikšanās laikā.<br><br>Atgriež "0", ja MFA ir globāli atspējota vai atspējota visām lietotāju grupām, kurām lietotājs pieder.|
|secret|string|Nejauša 32 rakstzīmju virkne. Tiek ģenerēta lietotāja pieteikšanās laikā.|
|sessionid|string|Autentifikācijas marķieris, kas jāizmanto turpmākajos API pieprasījumos.|
|type|integer|Lietotāja tips.<br><br>Iespējamo vērtību sarakstu skatiet [Role object](/manual/api/reference/role/object#role) īpašībā `type`.|
|userip|string|Lietotāja IP adrese.|

::: notetip
Ja lietotājs ir veiksmīgi autentificēts pēc viena
vai vairākiem neveiksmīgiem mēģinājumiem, metode atgriezīs pašreizējās vērtības
īpašībām `attempt_clock`, `attempt_failed` un `attempt_ip`, un
pēc tam tās atiestatīs.
:::

Ja parametrs `userData` netiek izmantots, metode atgriež autentifikācijas marķieri, kas ir nepieciešams [autentifikācijai](/manual/api#authentication).

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

[comment]: # ({b41637d2-b41637d2})
### Piemēri

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

[comment]: # ({ce05d68f-46abbe5a})
#### Lietotāja autentificēšana

Autentificējiet lietotāju.

[Pieprasījums](/manual/api#performing-requests):

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

Atbilde:

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

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

[comment]: # ({d81c0c1a-8448c8ab})
#### Autentificētā lietotāja informācijas pieprasīšana

Autentificējiet un atgrieziet papildu informāciju par lietotāju.

[Pieprasījums](/manual/api#performing-requests):

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

Atbilde:

```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})
### Skatīt arī

-   [user.logout](logout)

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

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

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

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