getAuthProviderByMarker

Name: OneEntry SDK
Author: OneEntry

الحصول على مزوّد مصادقة حسب علامته.

الوصف

يُعيد IAuthProvidersEntity.

.getAuthProviderByMarker(
,
);

مخطط المعلمات

المخطط

marker(مطلوب): string
علامة مزود المصادقة.
مثال: "email"

langCode: string
رمز اللغة. الافتراضي: langCode المُمرَّر إلى defineOneEntry ("en_US" إذا لم يُمرَّر).
مثال: "en_US"

أمثلة

مثال بسيط

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

مثال مع langCode

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

مثال على الاستجابة

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

مخطط الاستجابة

المخطط: IAuthProvidersEntity

id: number
معرّف مزود المصادقة.
مثال: 194

localizeInfos: ILocalizeInfo
البيانات المترجمة لمزود المصادقة.
مثال:

{
  "title": "Example title"
}

config: IAuthProvidersEntityConfig
إعدادات المزود كأزواج مفتاح-قيمة.
مثال:

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

config.accessTokenTtlSec: string
مدة صلاحية رمز الوصول، بالثواني.
مثال: "3600"

config.refreshTokenTtlMc: string
مدة صلاحية رمز التحديث، بالثواني (رغم اللاحقة Mc).
example: "604800"

config.deleteNoneActiveUsersAfterDays: string
عدد الأيام التي يُحذف بعدها المستخدمون غير النشطين.
مثال: "30"

config.systemCodeTlsSec: string
مدة صلاحية الرمز لمرة واحدة، بالثواني.
مثال: "86400"

config.systemCodeLength: string
طول الرمز لمرة واحدة.
مثال: "6"

config.oauthAuthUrl: string | null
رابط تفويض OAuth.
مثال: null

config.systemCodeOnlyNumbers: string | null
هل يستخدم الرمز لمرة واحدة أرقامًا فقط؛ null إذا لم يُعيَّن.
مثال: null

version: number
رقم إصدار مزود المصادقة؛ يتغير مع كل تحديث.
مثال: 1

identifier: string
علامة مزود المصادقة.
مثال: "email"

type: string
نوع مزود المصادقة، مثل "email".
مثال: "email"

formIdentifier: string | null
علامة النموذج المرتبط بمزود المصادقة، أو null إذا لم يوجد.
مثال: "reg_form"

userGroupIdentifier: string
معرّف مجموعة المستخدمين المرتبطة بمزود المصادقة.
مثال: "guest"

isActive: boolean
هل مزود المصادقة نشط.
مثال: true

isCheckCode: boolean
ما إذا كان يجب تفعيل المستخدمين الجدد برمز لمرة واحدة. يتيح أيضًا تسجيل الدخول برمز بدلًا من كلمة المرور.
مثال: false

الوصف​

مخطط المعلمات​

أمثلة​

مثال بسيط​

مثال مع langCode​

مثال على الاستجابة​

مخطط الاستجابة​