Auth0
CustomDomain
With Auth0, you can use a custom domain to maintain a consistent user experience. This resource allows you to create and manage a custom domain within your Auth0 tenant.
Example Usage
using Pulumi;
using Auth0 = Pulumi.Auth0;
class MyStack : Stack
{
public MyStack()
{
var myCustomDomain = new Auth0.CustomDomain("myCustomDomain", new Auth0.CustomDomainArgs
{
Domain = "auth.example.com",
Type = "auth0_managed_certs",
});
}
}
package main
import (
"github.com/pulumi/pulumi-auth0/sdk/v2/go/auth0"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := auth0.NewCustomDomain(ctx, "myCustomDomain", &auth0.CustomDomainArgs{
Domain: pulumi.String("auth.example.com"),
Type: pulumi.String("auth0_managed_certs"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myCustomDomain = new CustomDomain("myCustomDomain", CustomDomainArgs.builder()
.domain("auth.example.com")
.type("auth0_managed_certs")
.build());
}
}
import pulumi
import pulumi_auth0 as auth0
my_custom_domain = auth0.CustomDomain("myCustomDomain",
domain="auth.example.com",
type="auth0_managed_certs")
import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";
const myCustomDomain = new auth0.CustomDomain("my_custom_domain", {
domain: "auth.example.com",
type: "auth0_managed_certs",
});
resources:
myCustomDomain:
type: auth0:CustomDomain
properties:
domain: auth.example.com
type: auth0_managed_certs
Create a CustomDomain Resource
new CustomDomain(name: string, args: CustomDomainArgs, opts?: CustomResourceOptions);
@overload
def CustomDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain: Optional[str] = None,
type: Optional[str] = None)
@overload
def CustomDomain(resource_name: str,
args: CustomDomainArgs,
opts: Optional[ResourceOptions] = None)
func NewCustomDomain(ctx *Context, name string, args CustomDomainArgs, opts ...ResourceOption) (*CustomDomain, error)
public CustomDomain(string name, CustomDomainArgs args, CustomResourceOptions? opts = null)
public CustomDomain(String name, CustomDomainArgs args)
public CustomDomain(String name, CustomDomainArgs args, CustomResourceOptions options)
type: auth0:CustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomDomainArgs
- 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 CustomDomainArgs
- 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 CustomDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomDomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
CustomDomain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The CustomDomain resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomDomain resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- Primary bool
Boolean. Indicates whether this is a primary domain.
- Status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- Verifications
List<Custom
Domain Verification> List(Resource). Configuration settings for verification. For details, see Verification.
- Id string
The provider-assigned unique ID for this managed resource.
- Origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- Primary bool
Boolean. Indicates whether this is a primary domain.
- Status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- Verifications
[]Custom
Domain Verification Type List(Resource). Configuration settings for verification. For details, see Verification.
- id String
The provider-assigned unique ID for this managed resource.
- origin
Domain StringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary Boolean
Boolean. Indicates whether this is a primary domain.
- status String
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- verifications
List<Custom
Domain Verification> List(Resource). Configuration settings for verification. For details, see Verification.
- id string
The provider-assigned unique ID for this managed resource.
- origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary boolean
Boolean. Indicates whether this is a primary domain.
- status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- verifications
Custom
Domain Verification[] List(Resource). Configuration settings for verification. For details, see Verification.
- id str
The provider-assigned unique ID for this managed resource.
- origin_
domain_ strname String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary bool
Boolean. Indicates whether this is a primary domain.
- status str
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- verifications
Sequence[Custom
Domain Verification] List(Resource). Configuration settings for verification. For details, see Verification.
- id String
The provider-assigned unique ID for this managed resource.
- origin
Domain StringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary Boolean
Boolean. Indicates whether this is a primary domain.
- status String
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- verifications List<Property Map>
List(Resource). Configuration settings for verification. For details, see Verification.
Look up an Existing CustomDomain Resource
Get an existing CustomDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CustomDomainState, opts?: CustomResourceOptions): CustomDomain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
domain: Optional[str] = None,
origin_domain_name: Optional[str] = None,
primary: Optional[bool] = None,
status: Optional[str] = None,
type: Optional[str] = None,
verifications: Optional[Sequence[CustomDomainVerificationArgs]] = None) -> CustomDomain
func GetCustomDomain(ctx *Context, name string, id IDInput, state *CustomDomainState, opts ...ResourceOption) (*CustomDomain, error)
public static CustomDomain Get(string name, Input<string> id, CustomDomainState? state, CustomResourceOptions? opts = null)
public static CustomDomain get(String name, Output<String> id, CustomDomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Domain string
String. Name of the custom domain.
- Origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- Primary bool
Boolean. Indicates whether this is a primary domain.
- Status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- Type string
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- Verifications
List<Custom
Domain Verification Args> List(Resource). Configuration settings for verification. For details, see Verification.
- Domain string
String. Name of the custom domain.
- Origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- Primary bool
Boolean. Indicates whether this is a primary domain.
- Status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- Type string
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- Verifications
[]Custom
Domain Verification Type Args List(Resource). Configuration settings for verification. For details, see Verification.
- domain String
String. Name of the custom domain.
- origin
Domain StringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary Boolean
Boolean. Indicates whether this is a primary domain.
- status String
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- type String
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- verifications
List<Custom
Domain Verification Args> List(Resource). Configuration settings for verification. For details, see Verification.
- domain string
String. Name of the custom domain.
- origin
Domain stringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary boolean
Boolean. Indicates whether this is a primary domain.
- status string
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- type string
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- verifications
Custom
Domain Verification Args[] List(Resource). Configuration settings for verification. For details, see Verification.
- domain str
String. Name of the custom domain.
- origin_
domain_ strname String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary bool
Boolean. Indicates whether this is a primary domain.
- status str
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- type str
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- verifications
Sequence[Custom
Domain Verification Args] List(Resource). Configuration settings for verification. For details, see Verification.
- domain String
String. Name of the custom domain.
- origin
Domain StringName String. Once the configuration status is
ready
, the DNS name of the Auth0 origin server that handles traffic for the custom domain.- primary Boolean
Boolean. Indicates whether this is a primary domain.
- status String
String. Configuration status for the custom domain. Options include
disabled
,pending
,pending_verification
, andready
.- type String
String. Provisioning type for the custom domain. Options include
auth0_managed_certs
andself_managed_certs
.- verifications List<Property Map>
List(Resource). Configuration settings for verification. For details, see Verification.
Supporting Types
CustomDomainVerification
- Methods List<object>
List(Map). Verification methods for the domain.
- Methods []interface{}
List(Map). Verification methods for the domain.
- methods List<Object>
List(Map). Verification methods for the domain.
- methods any[]
List(Map). Verification methods for the domain.
- methods Sequence[Any]
List(Map). Verification methods for the domain.
- methods List<Any>
List(Map). Verification methods for the domain.
Import
Custom Domains can be imported using the id, e.g.
$ pulumi import auth0:index/customDomain:CustomDomain my_custom_domain cd_XXXXXXXXXXXXXXXX
Package Details
- Repository
- https://github.com/pulumi/pulumi-auth0
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
auth0
Terraform Provider.