Resource Type: keycloak_realm

Defined in:

lib/puppet/type/keycloak_realm.rb

Providers:

kcadm

Overview

Manage Keycloak realms

Examples:

Add a realm with a custom theme

keycloak_realm { 'test':
  ensure                   => 'present',
  remember_me              => true,
  login_with_email_allowed => false,
  login_theme              => 'my_theme',
}

Properties

• access_code_lifespan

  accessCodeLifespan

• access_code_lifespan_login

  accessCodeLifespanLogin

• access_code_lifespan_user_action

  accessCodeLifespanUserAction

• access_token_lifespan

  accessTokenLifespan

• access_token_lifespan_for_implicit_flow

  accessTokenLifespanForImplicitFlow

• account_theme (defaults to: keycloak)

  accountTheme

• action_token_generated_by_admin_lifespan

  actionTokenGeneratedByAdminLifespan

• action_token_generated_by_user_lifespan

  actionTokenGeneratedByUserLifespan

• admin_events_details_enabled (defaults to: false)

  adminEventsDetailsEnabled

  Supported values:

  • true
  • false
• admin_events_enabled (defaults to: false)

  adminEventsEnabled

  Supported values:

  • true
  • false
• admin_theme (defaults to: keycloak)

  adminTheme

• browser_flow (defaults to: browser)

  browserFlow

• brute_force_protected

  bruteForceProtected

  Supported values:

  • true
  • false
• client_authentication_flow (defaults to: clients)

  clientAuthenticationFlow

• content_security_policy (defaults to: frame-src 'self'; frame-ancestors 'self'; object-src 'none';)

  contentSecurityPolicy

• custom_properties

  custom properties to pass as realm configurations

• default_client_scopes

  Default Client Scopes

• default_locale

  defaultLocale

• direct_grant_flow (defaults to: direct grant)

  directGrantFlow

• display_name

  displayName

• display_name_html

  displayNameHtml

• docker_authentication_flow (defaults to: docker auth)

  dockerAuthenticationFlow

• duplicate_emails_allowed (defaults to: false)

  duplicateEmailsAllowed

  Supported values:

  • true
  • false
• edit_username_allowed (defaults to: false)

  editUsernameAllowed

  Supported values:

  • true
  • false
• email_theme (defaults to: keycloak)

  emailTheme

• enabled (defaults to: true)

  enabled

  Supported values:

  • true
  • false
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• events_enabled (defaults to: false)

  eventsEnabled

  Supported values:

  • true
  • false
• events_expiration

  eventsExpiration

• events_listeners (defaults to: ['jboss-logging'])

  eventsListeners

• internationalization_enabled (defaults to: false)

  internationalizationEnabled

  Supported values:

  • true
  • false
• login_theme (defaults to: keycloak)

  loginTheme

• login_with_email_allowed (defaults to: true)

  loginWithEmailAllowed

  Supported values:

  • true
  • false
• offline_session_idle_timeout

  offlineSessionIdleTimeout

• offline_session_max_lifespan

  offlineSessionMaxLifespan

• offline_session_max_lifespan_enabled (defaults to: false)

  offlineSessionMaxLifespanEnabled

  Supported values:

  • true
  • false
• optional_client_scopes

  Optional Client Scopes

• registration_allowed (defaults to: false)

  registrationAllowed

  Supported values:

  • true
  • false
• registration_flow (defaults to: registration)

  registrationFlow

• remember_me (defaults to: false)

  rememberMe

  Supported values:

  • true
  • false
• reset_credentials_flow (defaults to: reset credentials)

  resetCredentialsFlow

• reset_password_allowed (defaults to: false)

  resetPasswordAllowed

  Supported values:

  • true
  • false
• roles (defaults to: ['offline_access', 'uma_authorization'])

  roles

• smtp_server_auth

  smtpServer auth

  Supported values:

  • true
  • false
• smtp_server_envelope_from

  smtpServer envelope_from

• smtp_server_from

  smtpServer from

• smtp_server_from_display_name

  smtpServer fromDisplayName

• smtp_server_host

  smtpServer host

• smtp_server_password

  smtpServer password

• smtp_server_port

  smtpServer port

• smtp_server_reply_to

  smtpServer replyto

• smtp_server_reply_to_display_name

  smtpServer replyToDisplayName

• smtp_server_ssl

  smtpServer ssl

  Supported values:

  • true
  • false
• smtp_server_starttls

  smtpServer starttls

  Supported values:

  • true
  • false
• smtp_server_user

  smtpServer user

• ssl_required (defaults to: external)

  sslRequired

  Supported values:

  • none
  • all
  • external
• sso_session_idle_timeout

  ssoSessionIdleTimeout

• sso_session_idle_timeout_remember_me

  ssoSessionIdleTimeoutRememberMe

• sso_session_max_lifespan

  ssoSessionMaxLifespan

• sso_session_max_lifespan_remember_me

  ssoSessionMaxLifespanRememberMe

• supported_locales

  Supported Locales

• user_managed_access_allowed (defaults to: false)

  userManagedAccessAllowed

  Supported values:

  • true
  • false
• verify_email (defaults to: false)

  verifyEmail

  Supported values:

  • true
  • false

Parameters

• id

  Id. Default to name.

• manage_roles (defaults to: true)

  Manage realm roles

  Supported values:

  • true
  • false
• name (namevar)

  The realm name

• provider

  The specific backend to use for this keycloak_realm resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.