Resource Type: keycloak_flow

Defined in:

lib/puppet/type/keycloak_flow.rb

Providers:

kcadm

Overview

Manage a Keycloak flow Autorequires

• ‘keycloak_realm` defined for `realm` parameter

• ‘keycloak_flow` of `flow_alias` if `top_level=false`

• ‘keycloak_flow` of `flow_alias` if other `index` is lower and if `top_level=false`

• ‘keycloak_flow_execution` if `flow_alias` is the same and other `index` is lower and if `top_level=false`

Examples:

Add custom flow

keycloak_flow { 'browser-with-duo':
  ensure => 'present',
  realm  => 'test',
}

Add a flow execution to existing browser-with-duo flow

keycloak_flow { 'form-browser-with-duo under browser-with-duo on test':
  ensure      => 'present',
  index       => 2,
  requirement => 'ALTERNATIVE',
  top_level   => false,
}

Properties

• description

  description

• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• index

  execution index, only applied to top_level=false, required for top_level=false

• requirement

  requirement, only applied to top_level=false and defaults to DISABLED

  Supported values:

  • DISABLED
  • ALTERNATIVE
  • REQUIRED
  • CONDITIONAL
  • disabled
  • alternative
  • required
  • conditional

Parameters

• alias

  Alias. Default to ‘name`.

• flow_alias

  flowAlias, required for top_level=false

• id

  Id. Default to ‘$alias-$realm` when top_level is true. Only applies to top_level=true

• name (namevar)

  The flow name

• provider

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

• provider_id (defaults to: basic-flow)

  providerId

  Supported values:

  • basic-flow
  • form-flow
• realm

  realm

• top_level (defaults to: true)

  topLevel

  Supported values:

  • true
  • false
• type

  sub-flow execution provider, default to ‘registration-page-form` for top_level=false and does not apply to top_level=true