getAuthProviderByMarker

Obtener un proveedor de autenticación por su marcador.

Descripción

Se resuelve en un IAuthProvidersEntity.

.getAuthProviderByMarker(

,

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del proveedor de autenticación.
ejemplo: "email"

langCode: cadena
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

const response = await AuthProvider.getAuthProviderByMarker('email');

Ejemplo con langCode

const response = await AuthProvider.getAuthProviderByMarker('email', 'en_US');

Ejemplo de respuesta

{
  "id": 1,
  "localizeInfos": {
    "title": "email"
  },
  "config": {
    "accessTokenTtlSec": "36000",
    "refreshTokenTtlMc": "604800",
    "deleteNoneActiveUsersAfterDays": "2",
    "systemCodeTlsSec": "120",
    "systemCodeLength": "6",
    "systemCodeOnlyNumbers": null,
    "oauthAuthUrl": null
  },
  "version": 0,
  "identifier": "email",
  "type": "email",
  "formIdentifier": "reg",
  "userGroupIdentifier": "guest",
  "isActive": true,
  "isCheckCode": false
}

Esquema de respuesta

Esquema: IAuthProvidersEntity

id: número
ID del proveedor de autenticación.
ejemplo: 194

localizeInfos: ILocalizeInfo
Datos localizados del proveedor de autenticación.
ejemplo:

{
  "title": "Example title"
}

config: IAuthProvidersEntityConfig
Configuración del proveedor como pares clave-valor.
ejemplo:

{
  "accessTokenTtlSec": "36000",
  "refreshTokenTtlMc": "604800",
  "deleteNoneActiveUsersAfterDays": "2",
  "systemCodeTlsSec": "120",
  "systemCodeLength": "6",
  "systemCodeOnlyNumbers": null,
  "oauthAuthUrl": null
}

config.accessTokenTtlSec: string
Tiempo de vida del token de acceso, en segundos.
ejemplo: "3600"

config.refreshTokenTtlMc: string
Tiempo de vida del token de actualización, en segundos (a pesar del sufijo Mc).
example: "604800"

config.deleteNoneActiveUsersAfterDays: string
Número de días tras los cuales se eliminan los usuarios inactivos.
ejemplo: "30"

config.systemCodeTlsSec: string
Tiempo de vida del código de un solo uso, en segundos.
ejemplo: "86400"

config.systemCodeLength: string
Longitud del código de un solo uso.
ejemplo: "6"

config.oauthAuthUrl: string | null
URL de autorización de OAuth.
ejemplo: null

config.systemCodeOnlyNumbers: string | null
Indica si el código de un solo uso usa solo dígitos; null si no está definido.
ejemplo: null

version: número
Número de versión del proveedor de autenticación; cambia con cada actualización.
ejemplo: 1

identifier: cadena
Marcador del proveedor de autenticación.
ejemplo: "email"

type: string
Tipo del proveedor de autenticación, por ejemplo "email".
ejemplo: "email"

formIdentifier: string | null
Marcador del formulario vinculado al proveedor de autenticación, o null si no hay ninguno.
ejemplo: "reg_form"

userGroupIdentifier: string
Identificador del grupo de usuarios vinculado al proveedor de autenticación.
ejemplo: "guest"

isActive: boolean
Indica si el proveedor de autenticación está activo.
ejemplo: true

isCheckCode: boolean
Si los nuevos usuarios deben activarse con un código de un solo uso. También permite iniciar sesión con un código en lugar de una contraseña.
ejemplo: false

---