Resource Type: auth0_client

Defined in:

lib/puppet/type/auth0_client.rb

Overview

This type provides Puppet with the capabilities to manage Auth0 Client (Application) resources.

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

* `read:clients`
* `create:clients`
* `delete:clients`
* `update:clients`

Properties

• allowed_logout_urls

  A set of URLs that are valid to redirect to after logout from Auth0

• allowed_origins

  A set of URLs that represent valid origins for CORS.

• app_type

  The type of application this client represents. Common values include “native”, “spa” (single-page-application), “non_interactive” (Machine-to-Machine) and “regular_web”.

• callbacks

  A set of URLs that are valid to call back from Auth0 when authenticating users. To remove all callbacks you must specify an empty array; leaving this undefined will leave existing callbacks untouched.

• client_aliases

  List of audiences for SAML protocol.

• client_id

  Auth0 server-side unique identifier for Client.

• description

  Free text description of the purpose of this client.

• display_name

  The name of the client (Application). Does not allow “<” or “>”.

• ensure (defaults to: present)

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

• grant_types

  A set of grant types that the client is authorized to use

• jwt_alg

  The algorithm used to sign the JsonWebToken

• jwt_lifetime_in_seconds

  The amount of time (in seconds) that the token will be valid after being issued.

• keep_extra_allowed_logout_urls

  If true, allowed_logout_urls set in Auth0 but not in puppet will be left in place.

• keep_extra_allowed_origins

  If true, allowed_origins set in Auth0 but not in puppet will be left in place.

• keep_extra_callbacks

  If true, callbacks set in Auth0 but not in puppet will be left in place.

• keep_extra_web_origins

  If true, web_origins set in Auth0 but not in puppet will be left in place.

• logo_uri

  The URL of the client logo (recommended size: 150x150).

• oidc_conformant

  Whether this client will conform to string OIDC specifications.

• puppet_resource_identifier

  A unique identifier for this client; stored in the client_metadata hash under the key “puppet_resource_identifier”.

• sso

  Whether to use Auth0 instead of the IdP to do single sign on.

• sso_disabled

  Whether to disable Single Sign On

• token_endpoint_auth_method

  Defines the requested authentication methods for the token endpoint.

• web_origins

  A set of URLs that represents valid web origins for use with web message response mode.