Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide single index file for registry #630

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 219 additions & 2 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,222 @@
---
title: Auth0
meta_desc: The Auth0 provider for Pulumi can be used to provision any of the cloud resources available in Auth0.
title: Auth0 Provider
meta_desc: Provides an overview on how to configure the Pulumi Auth0 provider.
layout: package
---
## Installation

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

* JavaScript/TypeScript: [`@pulumi/auth0`](https://www.npmjs.com/package/@pulumi/auth0)
* Python: [`pulumi-auth0`](https://pypi.org/project/pulumi-auth0/)
* Go: [`github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0`](https://github.com/pulumi/pulumi-auth0)
* .NET: [`Pulumi.Auth0`](https://www.nuget.org/packages/Pulumi.Auth0)
* Java: [`com.pulumi/auth0`](https://central.sonatype.com/artifact/com.pulumi/auth0)

The Auth0 provider is used to interact with the [Auth0 Management API](https://auth0.com/docs/api/management/v2) 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 data sources.
## Example Usage

{{< chooser language "typescript,python,go,csharp,java,yaml" >}}
{{% choosable language typescript %}}
```yaml
# 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>

```

{{% /choosable %}}
{{% choosable language python %}}
```yaml
# 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>

```

{{% /choosable %}}
{{% choosable language csharp %}}
```yaml
# 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>

```

{{% /choosable %}}
{{% choosable language go %}}
```yaml
# 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>

```

{{% /choosable %}}
{{% choosable language yaml %}}
```yaml
# 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>

```

{{% /choosable %}}
{{% choosable language java %}}
```yaml
# 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>

```

{{% /choosable %}}
{{< /chooser >}}

> 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.

<!-- schema generated by tfplugindocs -->
## Configuration Reference

- `apiToken` (String) Your Auth0 [management api access token](https://auth0.com/docs/security/tokens/access-tokens/management-api-access-tokens). 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.

{{< chooser language "typescript,python,go,csharp,java,yaml" >}}
{{% choosable language typescript %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: nodejs

```

{{% /choosable %}}
{{% choosable language python %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: python

```

{{% /choosable %}}
{{% choosable language csharp %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: dotnet

```

{{% /choosable %}}
{{% choosable language go %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: go

```

{{% /choosable %}}
{{% choosable language yaml %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: yaml

```

{{% /choosable %}}
{{% choosable language java %}}
```yaml
# Pulumi.yaml provider configuration file
name: configuration-example
runtime: java

```

{{% /choosable %}}
{{< /chooser >}}
### Example Usage

```shell
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](https://auth0.com/docs/api/management/v2) to find your resource ID.
Loading
Loading