Ana içeriğe geç

getAuthProviders

Tüm kimlik doğrulama sağlayıcı nesnelerini al.

Açıklama

Bu yöntem, yetkilendirme sağlayıcılarının tüm nesnelerini alır. Bir Promise döner ve bu, IAuthProvidersEntity nesnelerinin bir dizisine çözülür.

AuthProvider.getAuthProviders(

langCode, offset, limit

);

Parametreler şeması

Şema

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalandırma için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalandırma için parametre. Varsayılan: 30
örnek: 30

Örnekler

Minimal örnek

const response = await AuthProvider.getAuthProviders();

Özelliklerle örnek

const response = await AuthProvider.getAuthProviders('en_US', 0, 30);

Örnek yanıt

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

Yanıt şeması

Şema: IAuthProvidersEntity[]

id: number
Kimlik doğrulama sağlayıcı varlıklarının benzersiz tanımlayıcısı.
örnek: 194

localizeInfos: ILocalizeInfo
Kimlik doğrulama sağlayıcısı için yerelleştirilmiş bilgiler.
örnek:

{
"key": "value"
}

config: IAuthProvidersEntityConfig
Kimlik doğrulama sağlayıcısı için yapılandırma ayarları, anahtar-değer çifti nesnesi olarak saklanır.
örnek:

{
"key": "value"
}

version: number
Kimlik doğrulama sağlayıcısı varlığının sürüm numarası.
örnek: 1

identifier: string
Kimlik doğrulama sağlayıcısını tanımlayan benzersiz bir dize.
örnek: "email"

type: string
Kimlik doğrulama sağlayıcısının türü (örneğin, 'email', 'google' vb.).
örnek: "email"

formIdentifier: string | null
Kimlik doğrulama sağlayıcısıyla ilişkili formun tanımlayıcısı veya geçerli değilse null.
örnek: "reg_form"

userGroupIdentifier: string
Kimlik doğrulama sağlayıcısıyla ilişkili kullanıcı grubunun tanımlayıcısı.
örnek: "guest"

isActive: boolean
Kimlik doğrulama sağlayıcısının aktif olup olmadığını gösterir.
örnek: true

isCheckCode: boolean
Kimlik doğrulama sağlayıcısının kod doğrulaması gerektirip gerektirmediğini gösterir.
örnek: false