Create a domain - Auth0 Docs

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.domains.create({
        domain: "acme.com",
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.domains.create({
        domain: "acme.com",
    });
}
main();

package example

import (
    context "context"

    myorganization "github.com/auth0/myorganization-go/v2"
    client "github.com/auth0/myorganization-go/v2/client"
    option "github.com/auth0/myorganization-go/v2/option"
)

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.CreateOrganizationDomainRequestContent{
        Domain: "acme.com",
    }
    c.Organization.Domains.Create(
        context.TODO(),
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Domains.CreateAsync(
            new CreateOrganizationDomainRequestContent {
                Domain = "acme.com"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.CreateOrganizationDomainRequestContent;

public class Example {
    public static void main(String[] args) {
        MyOrganizationClient client = MyOrganizationClient
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organization().domains().create(
            CreateOrganizationDomainRequestContent
                .builder()
                .domain("acme.com")
                .build()
        );
    }
}

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'acme.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"acme.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ord_aW1UHetvkBWSWdCCe8DWq7",
  "org_id": "org_zW1UHutvkVWSWdCC",
  "domain": "acme.com",
  "status": "pending",
  "verification_txt": "dove_text=asdfpiujnlewp-23849jdkfjzxcfpiawer",
  "verification_host": "_ss-verification.org_zW1UHutvkVWSWdCC.acme.com"
}

POST

domains

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.domains.create({
        domain: "acme.com",
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.domains.create({
        domain: "acme.com",
    });
}
main();

package example

import (
    context "context"

    myorganization "github.com/auth0/myorganization-go/v2"
    client "github.com/auth0/myorganization-go/v2/client"
    option "github.com/auth0/myorganization-go/v2/option"
)

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.CreateOrganizationDomainRequestContent{
        Domain: "acme.com",
    }
    c.Organization.Domains.Create(
        context.TODO(),
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Domains.CreateAsync(
            new CreateOrganizationDomainRequestContent {
                Domain = "acme.com"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.CreateOrganizationDomainRequestContent;

public class Example {
    public static void main(String[] args) {
        MyOrganizationClient client = MyOrganizationClient
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organization().domains().create(
            CreateOrganizationDomainRequestContent
                .builder()
                .domain("acme.com")
                .build()
        );
    }
}

curl --request POST \
  --url https://{tenantDomain}/my-org/v1/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/domains",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'acme.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/domains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"acme.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "ord_aW1UHetvkBWSWdCCe8DWq7",
  "org_id": "org_zW1UHutvkVWSWdCC",
  "domain": "acme.com",
  "status": "pending",
  "verification_txt": "dove_text=asdfpiujnlewp-23849jdkfjzxcfpiawer",
  "verification_host": "_ss-verification.org_zW1UHutvkVWSWdCC.acme.com"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

domain

string

required

Domain name.

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

Response

Domain successfully created for organization.

string

required

read-only

Organization domain identifier.

Pattern: ^ord_[A-Za-z0-9]{22}$

org_id

string

required

read-only

Organization identifier.

Pattern: ^org_[A-Za-z0-9]{16}$

domain

string

required

Domain name.

Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

status

enum<string>

required

Organization domain status.

Available options:

failed,

pending,

verified

verification_txt

string

required

Value used to verify the domain.

verification_host

string

required

Stores the full domain where the TXT record should be added.