auth

Cho phép bạn xác thực người dùng.

Description

Nó trả về một Promise mà giải quyết thành một đối tượng IAuthEntity.

AuthProvider.auth(

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

);

Parameters schema

Schema

marker(bắt buộc): string
Định danh văn bản của nhà cung cấp ủy quyền
ví dụ: "email"

body(bắt buộc): IAuthPostBody
Các đối tượng chứa thông tin xác thực
ví dụ:

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

body.authData(bắt buộc): IAuthData[]
Một mảng các đối tượng dữ liệu xác thực, mỗi đối tượng chứa một marker và giá trị tương ứng của nó.
ví dụ:

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

authData.marker(bắt buộc): string
Định danh cho trường xác thực.
ví dụ: "login"

authData.value(bắt buộc): string
Giá trị của trường xác thực.
ví dụ: .com"

body.authData any[]
Dữ liệu ủy quyền lấy từ biểu mẫu đính kèm với nhà cung cấp ủy quyền
ví dụ: ""

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

body.authData[index].marker string
Định danh thuộc tính đăng nhập của biểu mẫu đăng ký
ví dụ: "example@oneentry.cloud"

body.authData[index].value string
Giá trị thuộc tính đăng nhập của biểu mẫu đăng ký
ví dụ: "12345"

Examples

Minimal example

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

Example response

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

Response schema

Schema: IAuthEntity

userIdentifier: string
Định danh duy nhất cho người dùng.
ví dụ: "user12345"

authProviderIdentifier: string
Định danh cho nhà cung cấp xác thực.
ví dụ: "email"

accessToken: string
Token truy cập cho phiên người dùng.
ví dụ: "abcdef123456"

refreshToken: string
Token làm mới để gia hạn token truy cập.
ví dụ: "ghijkl789012"

---