المصادقة

يسمح لك بمصادقة المستخدمين.

الوصف

يعيد Promise يتم حله إلى كائن IAuthEntity.

AuthProvider.auth(

marker*, body*, body.authData*, authData.marker*, authData.value*

);

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

المخطط

marker(مطلوب): string
معرف النص لمزود التفويض
مثال: "email"

body(مطلوب): IAuthPostBody
كائنات تحتوي على معلومات المصادقة
مثال:

{
  "authData": [
    {
      "marker": "login",
      "value": "example@oneentry.cloud"
    },
    {
      "marker": "password",
      "value": "12345"
    }
  ]
}

body.authData(مطلوب): IAuthData[]
مصفوفة من كائنات بيانات المصادقة، كل منها يحتوي على علامة وقيمتها المقابلة.
مثال:

[
  {
    "marker": "login",
    "value": "user@example.com"
  }
]

authData.marker(مطلوب): string
العلامة التي تحدد حقل المصادقة.
مثال: "login"

authData.value(مطلوب): string
قيمة حقل المصادقة.
مثال: .com"

body.authData any[]
بيانات التفويض المأخوذة من النموذج المرفق بمزود التفويض
مثال: ""

[
  {
    "marker": "login",
    "value": "example@oneentry.cloud"
  },
  {
    "marker": "password",
    "value": "12345"
  }
]

body.authData[index].marker string
علامة خاصية تسجيل الدخول في النموذج
مثال: "example@oneentry.cloud"

body.authData[index].value string
قيمة خاصية تسجيل الدخول في النموذج
مثال: "12345"

أمثلة

مثال بسيط

const body = {
  "authData": [
    {
      "marker": "login",
      "value": "example@oneentry.cloud"
    },
    {
      "marker": "password",
      "value":"12345"
    }
  ]
};
const response = await AuthProvider.auth('email', body);

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

{
  "userIdentifier": "test@test.ru",
  "authProviderIdentifier": "email",
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpX...",
  "refreshToken": "1776262769878-0ef81b3a-6d47-49d8..."
}

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

المخطط: IAuthEntity

userIdentifier: string
المعرف الفريد للمستخدم.
مثال: "user12345"

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

accessToken: string
رمز الوصول لجلسة المستخدم.
مثال: "abcdef123456"

refreshToken: string
رمز التحديث لتجديد رمز الوصول.
مثال: "ghijkl789012"

---