Skip to main content
Version: 1.28.0

Realm

Identity-provider realm and its authentication, registration, theme, token, and role settings.

accessTokenLifespaninteger<int32>

Access-token lifetime in seconds.

Example: 300
accountThemestring
adminThemestring
displayNamestring

Human-readable realm label.

Example: Building Management
duplicateEmailsAllowedboolean
emailThemestring
enabledboolean

Whether users can authenticate against this realm.

Example: true
idstring

Identity-provider internal realm identifier.

loginThemestring
loginWithEmailboolean
namestring

Stable realm name used in API paths and tokens.

Example: building
notBeforenumber<double>
passwordPolicystring[]

Identity-provider password-policy rules.

realmRoles object[]

Realm-level roles available for assignment.

  • Array [
  • descriptionstring
    namestring
  • ]
  • registrationAllowedboolean
    registrationEmailAsUsernameboolean
    rememberMeboolean
    resetPasswordAllowedboolean
    verifyEmailboolean
    Realm
    {
    "accessTokenLifespan": 300,
    "accountTheme": "string",
    "adminTheme": "string",
    "displayName": "Building Management",
    "duplicateEmailsAllowed": true,
    "emailTheme": "string",
    "enabled": true,
    "id": "string",
    "loginTheme": "string",
    "loginWithEmail": true,
    "name": "building",
    "notBefore": 0,
    "passwordPolicy": [
    "string"
    ],
    "realmRoles": [
    {
    "description": "string",
    "name": "string"
    }
    ],
    "registrationAllowed": true,
    "registrationEmailAsUsername": true,
    "rememberMe": true,
    "resetPasswordAllowed": true,
    "verifyEmail": true
    }