Resource Type: auth0_connection

Defined in:

lib/puppet/type/auth0_connection.rb

Overview

This type provides Puppet with the capabilities to manage Auth0 Connections.

Note that this resource type makes use of the following scopes from the Auth0 Management API:

• read:connections
• create:connections
• delete:connections
• update:connections
• read:clients

Properties

• clients

  A list of client resource identifiers for which this connection is enabled.

• ensure (defaults to: present)

  Whether this resource should be present or absent on the target system.

• options

  A hash of options used to configure the Connection; structure of the hash depends on the selected Strategy.

• realms

  Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.

• strategy

  The type of the connection, related to the identity provider; common values include "ad" (Active Directory), "auth0" (Username-Password DB stored by Auth0), "google-oauth2", etc.

Parameters

• keep_extra_clients

  If true, clients enabled for this connection in Auth0 but not in Puppet will be left in place. Only matters is clients property is specified; otherwise clients are always left alone.

• keep_extra_options

  If true, options stored in Auth0 with no specified value in Puppet will be left as-is. Only matters if options property is specified; otherwise options is always left alone.

• name (namevar)

  The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128.