getAuthProviders

Получить все объекты провайдеров аутентификации.

Описание

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

AuthProvider.getAuthProviders(

langCode, offset, limit

);

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

Схема

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

offset: number
Параметр для постраничной навигации. По умолчанию: 0
пример: 0

limit: number
Параметр для постраничной навигации. По умолчанию: 30
пример: 30

Примеры

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

const response = await AuthProvider.getAuthProviders();

Пример с атрибутами

const response = await AuthProvider.getAuthProviders('en_US', 0, 30);

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

[
  {
    "id": 1,
    "localizeInfos": {
      "title": "email"
    },
    "config": {
      "accessTokenTtlSec": "36000",
      "refreshTokenTtlMc": "604800",
      "tokenSecretKey": "my-secret",
      "deleteNoneActiveUsersAfterDays": "2",
      "systemCodeTlsSec": "120",
      "systemCodeLength": "6"
    },
    "version": 0,
    "identifier": "email",
    "type": "email",
    "formIdentifier": "reg",
    "userGroupIdentifier": "guest",
    "isActive": true,
    "isCheckCode": false
  }
]

Схема ответа

Схема: IAuthProvidersEntity[]

id: number
Уникальный идентификатор сущности провайдера аутентификации.
пример: 194

localizeInfos: ILocalizeInfo
Локализованная информация для провайдера аутентификации.
пример:

{
  "key": "value"
}

config: IAuthProvidersEntityConfig
Настройки конфигурации для провайдера аутентификации, хранящиеся в виде объекта пар ключ-значение.
пример:

{
  "key": "value"
}

version: number
Номер версии сущности провайдера аутентификации.
пример: 1

identifier: string
Уникальная строка, идентифицирующая провайдера аутентификации.
пример: "email"

type: string
Тип провайдера аутентификации (например, 'email', 'google' и т.д.).
пример: "email"

formIdentifier: string | null
Идентификатор формы, связанной с провайдером аутентификации, или null, если не применимо.
пример: "reg_form"

userGroupIdentifier: string
Идентификатор группы пользователей, связанной с провайдером аутентификации.
пример: "guest"

isActive: boolean
Указывает, активен ли провайдер аутентификации.
пример: true

isCheckCode: boolean
Указывает, требуется ли проверка кода для провайдера аутентификации.
пример: false

---