getAuthProviderByMarker

Get one auth provider object by marker. It returns a Promise that resolves to an IAuthProvidersEntity object.

Description

AuthProvider.getAuthProviderByMarker(

marker, langCode

);

Parameters schema

Schema

marker(required): string
The text identifier of the authorization provider
example: "email"

langCode: string
Language code. Default: "en_US"
example: "en_US"

Examples

Minimal example

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

Example with attributes

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

Example response

{
  "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
}

Response schema

Schema: IAuthProvidersEntity

id: number
The unique identifier of the auth provider entity.
example: 194

localizeInfos: ILocalizeInfo
Localized information for the auth provider.
example:

{
  "key": "value"
}

config: IAuthProvidersEntityConfig
Configuration settings for the auth provider, stored as a key-value pair object.
example:

{
  "key": "value"
}

version: number
The version number of the auth provider entity.
example: 1

identifier: string
A unique string that identifies the auth provider.
example: "email"

type: string
The type of the auth provider (e.g., 'email', 'google', etc.).
example: "email"

formIdentifier: string | null
The identifier for the form associated with the auth provider, or null if not applicable.
example: "reg_form"

userGroupIdentifier: string
The identifier for the userGroup associated with the auth provider.
example: "guest"

isActive: boolean
Indicates whether the auth provider is active.
example: true

isCheckCode: boolean
Indicates whether the auth provider requires code verification.
example: false

---