Перейти к основному контенту

getUser

Получение данных авторизованного пользователя. 🔐 Этот метод требует авторизации.

Описание

Этот метод отправляет запрос для получения данных авторизованного пользователя. Он возвращает Promise, который разрешается в объект IUserEntity.

Users.getUser(

langCode

);

Схема параметров

Схема

langCode: string
Код языка. По умолчанию: "en_US"
пример: "en_US"

Примеры

Минимальный пример

// 1. Авторизация
await AuthProvider.auth("email", {
"authData": [
{
"marker": "email_reg",
"value": "your@email.com",
},
{
"marker": "password_reg",
"value": "yourPassword"
}
]
});

// 2. Получить пользователя
const response = await Users.getUser();

Пример ответа

{
"id": 8,
"identifier": "test@test.ru",
"authProviderIdentifier": "email",
"formData": [
{
"marker": "name_reg",
"type": "string",
"value": "Иван"
},
{
"marker": "phone_reg",
"type": "string",
"value": "+19258382556"
}
],
"formIdentifier": "reg",
"groups": [
1
],
"state": {}
}

Схема ответа

Схема: IUserEntity

id: number
Идентификатор объекта.
пример: 12345

identifier: string
Текстовый идентификатор для поля записи.
пример: "user_12345"

authProviderIdentifier: string
Текстовый идентификатор провайдера аутентификации.
пример: "auth_provider_12345"

formData: FormDataType[]
Массив объектов данных формы со следующими значениями.
пример:

[
{
"marker": "last_name",
"type": "string",
"value": "Имя пользователя"
}
]

formIdentifier: string
Текстовый идентификатор формы.
пример: "form_12345"

groups: any[]
Массив групп пользователей.
пример:

[
"group_1",
"group_2"
]

state: any
Объект, содержащий дополнительную информацию о состоянии пользователя.
пример:

{
"key": "value"
}