Ana içeriğe geç

auth

Kullanıcıları kimlik doğrulamanıza olanak tanır.

Açıklama​

Bir IAuthEntity nesnesine çözülmekte olan bir Promise döndürür.

AuthProvider.auth(

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

);

Parametreler şeması​

Şema

marker(zorunlu): string
Yetkilendirme sağlayıcısının metin tanımlayıcısı
örnek: "email"

body(zorunlu): IAuthPostBody
Kimlik doğrulama bilgilerini içeren nesneler
örnek:

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

body.authData(zorunlu): IAuthData[]
Her biri bir işaretçi ve karşılık gelen değerini içeren kimlik doğrulama verisi nesnelerinin bir dizisi.
örnek:

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

authData.marker(zorunlu): string
Kimlik doğrulama alanını tanımlayan işaretçi.
örnek: "login"

authData.value(zorunlu): string
Kimlik doğrulama alanının değeri.
örnek: .com"

body.authData any[]
Yetkilendirme sağlayıcısına ekli formdan alınan yetkilendirme verisi
örnek: "" 

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

body.authData[index].marker string
Kayıt formu giriş niteliği işaretçisi
örnek: "example@oneentry.cloud"

body.authData[index].value string
Kayıt formu giriş niteliği değeri
örnek: "12345"

Örnekler​

Minimal örnek​


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

const response = await AuthProvider.auth('email', body);

Örnek yanıt​

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

Yanıt şeması​

Şema: IAuthEntity

userIdentifier: string
Kullanıcı için benzersiz tanımlayıcı.
örnek: "user12345"

authProviderIdentifier: string
Kimlik doğrulama sağlayıcısının tanımlayıcısı.
örnek: "email"

accessToken: string
Kullanıcı oturumu için erişim belirteci.
örnek: "abcdef123456"

refreshToken: string
Erişim belirtecini yenilemek için yenileme belirteci.
örnek: "ghijkl789012"