メインコンテンツへスキップ
GET
/
custom-domains
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.customDomains.list();
}
main();
[
  {
    "custom_domain_id": "cd_0000000000000001",
    "domain": "login.mycompany.com",
    "primary": false,
    "status": "ready",
    "type": "self_managed_certs",
    "is_default": false,
    "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
    "verification": {
      "methods": [
        {
          "name": "txt",
          "record": "auth0-domain-verification=...",
          "domain": "_cf-custom-hostname.login.mycompany.com"
        }
      ],
      "status": "verified",
      "error_msg": "<string>",
      "last_verified_at": "<string>"
    },
    "custom_client_ip_header": "<string>",
    "tls_policy": "recommended",
    "domain_metadata": {},
    "certificate": {
      "status": "provisioning",
      "error_msg": "<string>",
      "certificate_authority": "letsencrypt",
      "renews_before": "<string>"
    },
    "relying_party_identifier": "<string>"
  }
]

承認

Authorization
string
header
必須

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

クエリパラメータ

take
integer

Number of results per page. Defaults to 50.

必須範囲: 1 <= x <= 100
from
string

Optional Id from which to start selection.

Maximum string length: 1000
q
string
Maximum string length: 1000
fields
string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Maximum string length: 100
include_fields
boolean

Whether specified fields are to be included (true) or excluded (false).

sort
string

Field to sort by. Only domain:1 (ascending order by domain) is supported at this time.

Maximum string length: 15
Pattern: ^domain:1$

レスポンス

Custom domains successfully retrieved.

custom_domain_id
string
デフォルト:cd_0000000000000001
必須

ID of the custom domain.

domain
string
デフォルト:login.mycompany.com
必須

Domain name.

primary
boolean
デフォルト:false
必須

Whether this is a primary domain (true) or not (false).

status
enum<string>
デフォルト:ready
必須

Custom domain configuration status. Can be failed, pending_verification, or ready.

利用可能なオプション:
pending_verification,
ready,
failed
type
enum<string>
デフォルト:self_managed_certs
必須

Custom domain provisioning type. Can be auth0_managed_certs or self_managed_certs.

利用可能なオプション:
auth0_managed_certs,
self_managed_certs
is_default
boolean
デフォルト:false

Whether this is the default custom domain (true) or not (false).

origin_domain_name
string
デフォルト:mycompany_cd_0000000000000001.edge.tenants.auth0.com

Intermediate address.

verification
object

Domain verification settings.

custom_client_ip_header
string | null

The HTTP header to fetch the client's IP address

tls_policy
string
デフォルト:recommended

The TLS version policy

domain_metadata
object

Domain metadata associated with the custom domain, in the form of an object with string values (max 255 chars). Maximum of 10 domain metadata properties allowed.

certificate
object

Certificate information. This object is relevant only for Custom Domains with Auth0-Managed Certificates.

relying_party_identifier
string<hostname>

Relying Party ID (rpId) to be used for Passkeys on this custom domain. If not present, the full domain will be used.