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

Interface: RealmView

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

A realm as read. Never carries a secret.

Properties​

bruteForce​

readonly bruteForce: BruteForcePolicy | undefined

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

Brute force, as far as the provider reports it.


displayName​

readonly displayName: string | undefined

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

Display name, when the provider has one.


invitationMail?​

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

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

The invitation mail of each locale ReadRealmOptions.invitationMailLocales named; undefined when none was asked for or the provider keeps no such text.


invitationMailUnsupported?​

readonly optional invitationMailUnsupported?: string

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

Set, to the reason, by an adapter that can neither write nor read the invitation mail at all, whatever its credential may do. Absent on an adapter that can.

It exists for a caller that must not probe, which is a plan: with RealmView.invitationMail alone, "the realm holds no override" and "this provider has no such thing" look the same, and the first is a change an apply would make while the second is a finding that no apply can clear. Reading it as a change made every plan of a converged WSO2 deployment report changed: true.


issuer​

readonly issuer: string

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

The iss of every token the realm issues, read from its own discovery document.


jwksUri​

readonly jwksUri: string

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

Where the realm's signing keys are, read from the same document. On Keycloak the host is the one this process asked (its backchannel URL is dynamic), so it is the address to fetch keys from here, not necessarily the public one; issuer is always the public identifier.


locales​

readonly locales: readonly string[] | undefined

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

Locales; undefined where the provider has none.


passwordPolicy​

readonly passwordPolicy: PasswordPolicy | undefined

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

Password policy, as far as the provider reports it.


realm​

readonly realm: string

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

The logical realm name, as the caller gave it.


selfRegistration​

readonly selfRegistration: boolean | undefined

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

Self-registration.


smtp​

readonly smtp: Omit<SmtpSettings, "auth"> & object | undefined

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

SMTP without its password; passwordSet says whether one is held.