MadelineProtoDocs/old_docs/API_docs_v27/methods/auth.checkPassword.md

56 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.checkPassword
2020-06-16 17:50:25 +02:00
description: Try logging to an account protected by a [2FA password](https://core.telegram.org/api/srp).
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/auth_checkPassword.html
2018-04-01 13:19:25 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: auth.checkPassword
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Try logging to an account protected by a [2FA password](https://core.telegram.org/api/srp).
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|password|[InputCheckPasswordSRP](../types/InputCheckPasswordSRP.md) | The account's password (see [SRP](https://core.telegram.org/api/srp)) | Yes|
2019-09-02 17:41:28 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [auth.Authorization](../types/auth.Authorization.md)
2019-09-02 17:41:28 +02:00
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2020-06-16 17:50:25 +02:00
$auth.Authorization = $MadelineProto->auth->checkPassword(['password' => InputCheckPasswordSRP, ]);
2019-09-02 17:41:28 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
auth.Authorization = auth.checkPassword({password=InputCheckPasswordSRP, })
2019-09-02 17:41:28 +02:00
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|PASSWORD_HASH_INVALID|The provided password hash is invalid|
2020-01-10 14:18:02 +01:00
|400|SRP_ID_INVALID|Invalid SRP ID provided|
|400|SRP_PASSWORD_CHANGED|Password has changed|
2018-04-01 13:19:25 +02:00