# Auth

## Обзор

Класс `Auth` предназначен для доступа к пользовательской информации на стороне клиента и для выполнения запросов к API, связанных с аутентификацией пользователя.

## Свойства экземпляра

### `locale`

Язык, используемый текущим пользователем.

### `role`

Роль, используемая текущим пользователем.

### `token`

Токен API.

### `authenticator`

Аутентификатор, используемый для аутентификации текущего пользователя. См. [Аутентификация пользователя](../../auth-verification/auth/index.md).

## Методы класса

### `signIn()`

Вход пользователя.

#### Сигнатура

- `async signIn(values: any, authenticator?: string): Promise<AxiosResponse<any>>`

#### Подробности

| Параметр        | Тип      | Описание                                      |
| --------------- | -------- | --------------------------------------------- |
| `values`        | `any`    | Параметры запроса для API входа.              |
| `authenticator` | `string` | Идентификатор аутентификатора, используемого для входа. |

### `signUp()`

Регистрация пользователя.

#### Сигнатура

- `async signUp(values: any, authenticator?: string): Promise<AxiosResponse<any>>`

#### Подробности

| Параметр        | Тип      | Описание                                      |
| --------------- | -------- | --------------------------------------------- |
| `values`        | `any`    | Параметры запроса для API регистрации.        |
| `authenticator` | `string` | Идентификатор аутентификатора, используемого для регистрации. |

### `signOut()`

Выход из системы.

#### Сигнатура

- `async signOut(values: any, authenticator?: string): Promise<AxiosResponse<any>>`

#### Подробности

| Параметр        | Тип      | Описание                                      |
| --------------- | -------- | --------------------------------------------- |
| `values`        | `any`    | Параметры запроса для API выхода.             |
| `authenticator` | `string` | Идентификатор аутентификатора, используемого для выхода. |