Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

Auth0 Provider

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    Installation

    The auth0 provider is available as a package in all Pulumi languages:

    Overview

    The Auth0 provider is used to interact with the Auth0 Management API in order to configure an Auth0 Tenant.

    It provides resources that allow you to create and manage clients, resource servers, client grants, connections, email providers and templates, rules and rule variables, users, roles, tenants, custom domains, and many more, as part of a Pulumi deployment.

    Use the navigation to the left to read about the available resources and functions.

    Example Usage

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: python
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: go
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: java
config:
    auth0:clientId:
        value: <client-id>
    auth0:clientSecret:
        value: <client-secret>
    auth0:debug:
        value: <debug>
    auth0:domain:
        value: <domain>

    Hard-coding credentials into any Pulumi configuration is not recommended, and risks secret leakage should this file ever be committed to a public version control system. See Environment Variables for a better alternative.

    Configuration Reference

    • apiToken (String) Your Auth0 management api access token. It can also be sourced from the AUTH0_API_TOKEN environment variable. It can be used instead of clientId + clientSecret. If both are specified, apiToken will be used over clientId + clientSecret fields.
    • audience (String) Your Auth0 audience when using a custom domain. It can also be sourced from the AUTH0_AUDIENCE environment variable.
    • clientId (String) Your Auth0 client ID. It can also be sourced from the AUTH0_CLIENT_ID environment variable.
    • clientSecret (String) Your Auth0 client secret. It can also be sourced from the AUTH0_CLIENT_SECRET environment variable.
    • debug (Boolean) Indicates whether to turn on debug mode.
    • domain (String) Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.

    Environment Variables

    You can provide your credentials via the AUTH0_DOMAIN, AUTH0_CLIENT_ID and AUTH0_CLIENT_SECRET or AUTH0_API_TOKEN environment variables, respectively.

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: python

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: go

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml

    # Pulumi.yaml provider configuration file
name: configuration-example
runtime: java

    Example Usage

    AUTH0_DOMAIN="<domain>" \
AUTH0_CLIENT_ID="<client-id>" \
AUTH0_CLIENT_SECRET="<client_secret>" \
pulumi preview

    Importing resources

    To import Auth0 resources, you will need to know their ID. You can use the Auth0 API Explorer to find your resource ID.

    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0