انتقل إلى المحتوى الرئيسي

Interface: RealmSpec

Defined in: packages/identity/src/port.ts:226

What IdentityProvider.ensureRealm converges. Every field but displayName is optional: an absent field is left alone.

Properties​

bruteForce?​

readonly optional bruteForce?: BruteForcePolicy

Defined in: packages/identity/src/port.ts:234

Brute-force detection.

displayName​

readonly displayName: string

Defined in: packages/identity/src/port.ts:228

Shown at sign-in.

invitationMail?​

readonly optional invitationMail?: Readonly<Record<string, InvitationMail>>

Defined in: packages/identity/src/port.ts:259

The invitation mail per locale, each locale one the realm offers (locales, or the realm's own when locales is absent). Only the texts given are written and nothing is removed: a locale or key left out keeps whatever the realm holds. On WSO2 it is reported unsupported until spike N-WSO2-ASKPASSWORD-MAIL.

locales?​

readonly optional locales?: readonly string[]

Defined in: packages/identity/src/port.ts:236

Locales, the first of which is the default.

passwordPolicy?​

readonly optional passwordPolicy?: PasswordPolicy

Defined in: packages/identity/src/port.ts:232

Password policy.

personNames?​

readonly optional personNames?: PersonNamePolicy

Defined in: packages/identity/src/port.ts:246

Accept every name the platform's contract allows, in given and family name.

requiredActions?​

readonly optional requiredActions?: readonly ("verify-email" | "update-password" | "configure-totp")[]

Defined in: packages/identity/src/port.ts:244

Which required actions the realm offers. On WSO2, configure-totp turns on TOTP enrolment during sign-in for the tenant; the second step itself is per application (PublicClientSpec.secondFactor).

selfRegistration?​

readonly optional selfRegistration?: boolean

Defined in: packages/identity/src/port.ts:230

Whether the public may register. Always false for the staff realm.

signInWithEmail?​

readonly optional signInWithEmail?: boolean

Defined in: packages/identity/src/port.ts:252

Let a person sign in with their email address as well as their username (QA F7). The platform gives persons opaque usernames, so the address is what they know. Keycloak's loginWithEmailAllowed, with duplicate addresses refused; WSO2's multi-attribute login.

smtp?​

readonly optional smtp?: SmtpSettings

Defined in: packages/identity/src/port.ts:238

The relay the realm sends its own mail through; absent leaves the provider's setting alone.