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

auth0.Provider

Explore with Pulumi AI

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

    The provider type for the auth0 package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
def Provider(resource_name: str,
             args: Optional[ProviderArgs] = None,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             api_token: Optional[str] = None,
             audience: Optional[str] = None,
             client_id: Optional[str] = None,
             client_secret: Optional[str] = None,
             debug: Optional[bool] = None,
             domain: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

    type: pulumi:providers:auth0
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    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 client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret 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 bool
    Indicates whether to turn on debug mode. It can also be sourced from the following environment variable: AUTH0_DEBUG
    Domain string
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.
    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 client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret 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 bool
    Indicates whether to turn on debug mode. It can also be sourced from the following environment variable: AUTH0_DEBUG
    Domain string
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.
    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 client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret 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. It can also be sourced from the following environment variable: AUTH0_DEBUG
    domain String
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.
    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 client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret 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. It can also be sourced from the following environment variable: AUTH0_DEBUG
    domain string
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.
    api_token str
    Your Auth0 management api access token. It can also be sourced from the AUTH0_API_TOKEN environment variable. It can be used instead of client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret fields.
    audience str
    Your Auth0 audience when using a custom domain. It can also be sourced from the AUTH0_AUDIENCE environment variable.
    client_id str
    Your Auth0 client ID. It can also be sourced from the AUTH0_CLIENT_ID environment variable.
    client_secret str
    Your Auth0 client secret. It can also be sourced from the AUTH0_CLIENT_SECRET environment variable.
    debug bool
    Indicates whether to turn on debug mode. It can also be sourced from the following environment variable: AUTH0_DEBUG
    domain str
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.
    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 client_id + client_secret. If both are specified, api_token will be used over client_id + client_secret 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. It can also be sourced from the following environment variable: AUTH0_DEBUG
    domain String
    Your Auth0 domain name. It can also be sourced from the AUTH0_DOMAIN environment variable.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0