Skip to main content

getMarker

Retrieve an authentication provider object using a marker.

AuthProvider?.getMarker( marker?, langCode? );

Minimal example

const value = await AuthProvider.getMarker('email')
Schema

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

langCode: string
Language code. Default: "en_US"
example: "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
}
Schema

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

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

{
"key": "value"
}

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

{
"key": "value"
}

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

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

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

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

userGroupIdentifier: string
The identifier for the user group associated with the authentication provider.
example: "guest"

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

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