Create an organization discovery domain

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.discoveryDomains.create("id", {
        domain: "domain",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.discoveryDomains.create("id", {
        domain: "domain",
    });
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateOrganizationDiscoveryDomainRequestContent{
        Domain: "domain",
    }
    mgmt.Organizations.DiscoveryDomains.Create(
        context.TODO(),
        "id",
        request,
    )
}

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.DiscoveryDomains.CreateAsync(
            id: "id",
            request: new CreateOrganizationDiscoveryDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationDiscoveryDomainRequestContent;

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

        client.organizations().discoveryDomains().create(
            "id",
            CreateOrganizationDiscoveryDomainRequestContent
                .builder()
                .domain("domain")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\DiscoveryDomains\Requests\CreateOrganizationDiscoveryDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->discoveryDomains->create(
    'id',
    new CreateOrganizationDiscoveryDomainRequestContent([
        'domain' => 'domain',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.discovery_domains.create(
    id="id",
    domain="domain",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "use_for_organization_discovery": true
}
'

{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "verification_txt": "<string>",
  "verification_host": "<string>",
  "use_for_organization_discovery": true
}

POST

https://{tenantDomain}/api/v2

organizations

{id}

discovery-domains

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.discoveryDomains.create("id", {
        domain: "domain",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.discoveryDomains.create("id", {
        domain: "domain",
    });
}
main();

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateOrganizationDiscoveryDomainRequestContent{
        Domain: "domain",
    }
    mgmt.Organizations.DiscoveryDomains.Create(
        context.TODO(),
        "id",
        request,
    )
}

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.DiscoveryDomains.CreateAsync(
            id: "id",
            request: new CreateOrganizationDiscoveryDomainRequestContent {
                Domain = "domain"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationDiscoveryDomainRequestContent;

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

        client.organizations().discoveryDomains().create(
            "id",
            CreateOrganizationDiscoveryDomainRequestContent
                .builder()
                .domain("domain")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\DiscoveryDomains\Requests\CreateOrganizationDiscoveryDomainRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->discoveryDomains->create(
    'id',
    new CreateOrganizationDiscoveryDomainRequestContent([
        'domain' => 'domain',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.discovery_domains.create(
    id="id",
    domain="domain",
)

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "use_for_organization_discovery": true
}
'

{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "verification_txt": "<string>",
  "verification_host": "<string>",
  "use_for_organization_discovery": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Scopes

create:organization_discovery_domains

Create Organization Discovery Domains

Path Parameters

string

required

ID of the organization.

Body

domain

string

required

The domain name to associate with the organization e.g. acme.com.

Required string length: 3 - 255

status

enum<string>

The verification status of the discovery domain.

Available options:

pending,

verified

use_for_organization_discovery

boolean

Indicates whether this domain should be used for organization discovery.

Response

Organization discovery domain successfully created.

string<organization-discovery-domain-id>

required

Organization discovery domain identifier.

domain

string

required

The domain name to associate with the organization e.g. acme.com.

Required string length: 3 - 255

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

The verification status of the discovery domain.

Available options:

pending,

verified

verification_txt

string

required

A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership.

verification_host

string

required

The full domain where the TXT record should be added.

use_for_organization_discovery

boolean

Indicates whether this domain should be used for organization discovery.