Resource Type: keycloak_required_action

Defined in:

lib/puppet/type/keycloak_required_action.rb

Providers:

kcadm

Overview

Manage Keycloak required actions

Examples:

Enable Webauthn Register and make it default

keycloak_required_action { 'webauthn-register on master':
  ensure       => present,
  alias        => 'webauthn-register',
  provider_id  => 'webauthn-register',
  display_name => 'Webauthn Register',
  default      => true,
  enabled      => true,
  priority     => 1,
  config       => {
    'something' => 'true', # keep in mind that keycloak only supports strings for both keys and values
    'smth else' => '1',
  },
}

@example Minimal example to enable email verification without making it default
keycloak_required_action { 'VERIFY_EMAIL on master':
  ensure => present,
}

Properties

• config

  Required action config

• default (defaults to: false)

  If the required action is a default one. Default to false

  Supported values:

  • true
  • false
• display_name

  Displayed name.

• enabled (defaults to: true)

  If the required action is enabled. Default to true.

  Supported values:

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

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• priority

  Required action priority

Parameters

• alias

  Alias.

• name (namevar)

  The required action name

• provider

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

• provider_id

  providerId of the required action. Default to alias

• realm

  realm