Obtener dominios personalizados

Recupera detalles sobre dominios personalizados.

GET https://{tenantDomain}/api/v2/custom-domains

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.CustomDomains.List(
        context.TODO(),
    )
}

200

[
  {
    "custom_domain_id": "cd_0000000000000001",
    "domain": "login.mycompany.com",
    "primary": false,
    "status": "ready",
    "type": "self_managed_certs",
    "certificate": {
      "error_msg": "<string>",
      "renews_before": "<string>"
    },
    "custom_client_ip_header": "<string>",
    "domain_metadata": {},
    "is_default": false,
    "origin_domain_name": "mycompany_cd_0000000000000001.edge.tenants.auth0.com",
    "relying_party_identifier": "<string>",
    "tls_policy": "recommended",
    "verification": {
      "error_msg": "<string>",
      "last_verified_at": "<string>",
      "methods": [
        {
          "name": "txt",
          "record": "auth0-domain-verification=...",
          "domain": "_cf-custom-hostname.login.mycompany.com"
        }
      ]
    }
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

take · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

from · string

Id opcional desde el que se iniciará la selección.

Maximum string length: 1000

q · string

Consulta con la sintaxis de cadena de consulta de Lucene.

Maximum string length: 1000

fields · string

Lista de campos separados por comas que se incluirán o excluirán (según el valor proporcionado para include_fields) en el resultado. Déjelo vacío para recuperar todos los campos.

Maximum string length: 100

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false).

sort · string

Campo por el que ordenar. Por el momento, solo se admite domain:1 (orden ascendente por dominio).

Maximum string length: 15

Respuesta

200

application/json

Dominios personalizados recuperados correctamente.

object[]

object

custom_domain_id · string · predeterminado: cd_0000000000000001 · requerido

ID del dominio personalizado.

domain · string · predeterminado: login.mycompany.com · requerido

Nombre de dominio.

primary · boolean · predeterminado: false · requerido

Indica si este es un dominio principal (true) o no (false).

status · enum<string> · predeterminado: ready · requerido

Estado de la configuración del dominio personalizado. Puede ser failed, pending_verification o ready.

Opciones disponibles: pending_verification, ready, failed

type · enum<string> · predeterminado: self_managed_certs · requerido

Tipo de aprovisionamiento del dominio personalizado. Puede ser auth0_managed_certs o self_managed_certs.

Opciones disponibles: auth0_managed_certs, self_managed_certs

certificate · object

Información del certificado. Este objeto solo es relevante para dominios personalizados con certificados administrados por Auth0.

Show child attributes

custom_client_ip_header · string | null

El encabezado HTTP para obtener la dirección IP del cliente

domain_metadata · object

Metadatos del dominio asociados al dominio personalizado, en forma de un objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 10 propiedades de metadatos de dominio.

Show child attributes

is_default · boolean · predeterminado: false

Indica si este es el dominio personalizado predeterminado (true) o no (false).

origin_domain_name · string · predeterminado: mycompany_cd_0000000000000001.edge.tenants.auth0.com

Dirección intermedia.

relying_party_identifier · string<hostname>

ID de la parte de confianza (rpId) que se usará para claves de acceso en este dominio personalizado. Si no está presente, se usará el dominio completo.

tls_policy · string · predeterminado: recommended

La política de versión de TLS

verification · object

Configuración de verificación del dominio.

Show child attributes