Obtener clientes

Recupere los clientes (aplicaciones e integraciones de SSO) que coincidan con los filtros proporcionados. También se puede especificar una lista de campos para incluir o excluir. Para obtener más información, consulte Applications in Auth0 y inicio de sesión único.

• Lo siguiente puede recuperarse con cualquier scope: client_id, app_type, name y description.
• Las siguientes propiedades solo pueden recuperarse con el scope read:clients o read:client_keys: callbacks, oidc_logout, allowed_origins, web_origins, tenant, global, config_route, callback_url_template, jwt_configuration, jwt_configuration.lifetime_in_seconds, jwt_configuration.secret_encoded, jwt_configuration.scopes, jwt_configuration.alg, api_type, logo_uri, allowed_clients, owners, custom_login_page, custom_login_page_off, sso, addons, form_template, custom_login_page_codeview, resource_servers, client_metadata, mobile, mobile.android, mobile.ios, allowed_logout_urls, token_endpoint_auth_method, is_first_party, oidc_conformant, is_token_endpoint_ip_header_trusted, initiate_login_uri, grant_types, refresh_token, refresh_token.rotation_type, refresh_token.expiration_type, refresh_token.leeway, refresh_token.token_lifetime, refresh_token.policies, organization_usage, organization_require_behavior.
• Las siguientes propiedades solo pueden recuperarse con los scopes read:client_keys o read:client_credentials: encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods y signing_key.

GET https://{tenantDomain}/api/v2/clients

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.ListClientsRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        IsGlobal: management.Bool(
            true,
        ),
        IsFirstParty: management.Bool(
            true,
        ),
        AppType: management.String(
            "app_type",
        ),
        Q: management.String(
            "q",
        ),
    }
    client.Clients.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "addons": {
      "aws": {
        "lifetime_in_seconds": 22050,
        "principal": "<string>",
        "role": "<string>"
      },
      "azure_blob": {
        "accountName": "<string>",
        "blobName": "<string>",
        "blob_delete": true,
        "blob_read": true,
        "blob_write": true,
        "containerName": "<string>",
        "container_delete": true,
        "container_list": true,
        "container_read": true,
        "container_write": true,
        "expiration": 1,
        "signedIdentifier": "<string>",
        "storageAccessKey": "<string>"
      },
      "azure_sb": {
        "entityPath": "<string>",
        "expiration": 123,
        "namespace": "<string>",
        "sasKey": "<string>",
        "sasKeyName": "<string>"
      },
      "box": {},
      "cloudbees": {},
      "concur": {},
      "dropbox": {},
      "echosign": {
        "domain": "<string>"
      },
      "egnyte": {
        "domain": "<string>"
      },
      "firebase": {
        "client_email": "<string>",
        "lifetime_in_seconds": 123,
        "private_key": "<string>",
        "private_key_id": "<string>",
        "secret": "<string>"
      },
      "layer": {
        "keyId": "<string>",
        "privateKey": "<string>",
        "providerId": "<string>",
        "expiration": 1,
        "principal": "<string>"
      },
      "mscrm": {
        "url": "<string>"
      },
      "newrelic": {
        "account": "<string>"
      },
      "oag": {},
      "office365": {
        "connection": "<string>",
        "domain": "<string>"
      },
      "rms": {
        "url": "<string>"
      },
      "salesforce": {
        "entity_id": "<string>"
      },
      "salesforce_api": {
        "clientid": "<string>",
        "communityName": "<string>",
        "community_url_section": "<string>",
        "principal": "<string>"
      },
      "salesforce_sandbox_api": {
        "clientid": "<string>",
        "communityName": "<string>",
        "community_url_section": "<string>",
        "principal": "<string>"
      },
      "samlp": {
        "audience": "<string>",
        "authnContextClassRef": "<string>",
        "createUpnClaim": true,
        "destination": "<string>",
        "digestAlgorithm": "<string>",
        "issuer": "<string>",
        "lifetimeInSeconds": 123,
        "mapIdentities": true,
        "mapUnknownClaimsAsIs": true,
        "mappings": {},
        "nameIdentifierFormat": "<string>",
        "nameIdentifierProbes": [
          "<string>"
        ],
        "passthroughClaimsWithNoMapping": true,
        "recipient": "<string>",
        "signResponse": true,
        "signatureAlgorithm": "<string>"
      },
      "sap_api": {
        "clientid": "<string>",
        "nameIdentifierFormat": "<string>",
        "scope": "<string>",
        "servicePassword": "<string>",
        "tokenEndpointUrl": "<string>",
        "usernameAttribute": "<string>"
      },
      "sentry": {
        "base_url": "<string>",
        "org_slug": "<string>"
      },
      "sharepoint": {
        "external_url": [
          "<string>"
        ],
        "url": "<string>"
      },
      "slack": {
        "team": "<string>"
      },
      "springcm": {
        "acsurl": "<string>"
      },
      "sso_integration": {
        "name": "<string>",
        "version": "<string>"
      },
      "wams": {
        "masterkey": "<string>"
      },
      "wsfed": {},
      "zendesk": {
        "accountName": "<string>"
      },
      "zoom": {
        "account": "<string>"
      }
    },
    "allowed_clients": [
      "<string>"
    ],
    "allowed_logout_urls": [
      "<string>"
    ],
    "allowed_origins": [
      "<string>"
    ],
    "async_approval_notification_channels": [],
    "callbacks": [
      "<string>"
    ],
    "client_aliases": [
      "<string>"
    ],
    "client_authentication_methods": {
      "private_key_jwt": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      },
      "self_signed_tls_client_auth": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      },
      "tls_client_auth": {
        "credentials": [
          {
            "id": "<string>"
          }
        ]
      }
    },
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "client_metadata": {},
    "client_secret": "MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H",
    "cross_origin_authentication": true,
    "cross_origin_loc": "<string>",
    "custom_login_page": "",
    "custom_login_page_on": true,
    "custom_login_page_preview": "",
    "default_organization": {
      "flows": [],
      "organization_id": "<string>"
    },
    "description": "",
    "encryption_key": {
      "cert": "<string>",
      "pub": "<string>",
      "subject": "<string>"
    },
    "express_configuration": {
      "admin_login_domain": "<string>",
      "connection_profile_id": "<string>",
      "enable_client": true,
      "enable_organization": true,
      "initiate_login_uri_template": "<string>",
      "okta_oin_client_id": "<string>",
      "user_attribute_profile_id": "<string>",
      "linked_clients": [
        {
          "client_id": "<string>"
        }
      ],
      "oin_submission_id": "<string>"
    },
    "external_client_id": "<string>",
    "fedcm_login": "<unknown>",
    "form_template": "",
    "global": false,
    "grant_types": [
      "<string>"
    ],
    "initiate_login_uri": "<string>",
    "is_first_party": false,
    "is_token_endpoint_ip_header_trusted": false,
    "jwks_uri": "<string>",
    "jwt_configuration": {
      "alg": "HS256",
      "lifetime_in_seconds": 36000,
      "scopes": {},
      "secret_encoded": true
    },
    "logo_uri": "<string>",
    "mobile": {
      "android": {
        "app_package_name": "",
        "sha256_cert_fingerprints": [
          "<string>"
        ]
      },
      "ios": {
        "app_bundle_identifier": "",
        "team_id": ""
      }
    },
    "my_organization_configuration": {
      "allowed_strategies": [],
      "connection_deletion_behavior": "allow",
      "connection_profile_id": "<string>",
      "user_attribute_profile_id": "<string>"
    },
    "name": "My application",
    "native_social_login": "<unknown>",
    "oidc_conformant": false,
    "oidc_logout": {
      "backchannel_logout_initiators": {
        "selected_initiators": []
      },
      "backchannel_logout_session_metadata": {
        "include": true
      },
      "backchannel_logout_urls": [
        "<string>"
      ]
    },
    "organization_discovery_methods": [],
    "organization_require_behavior": "no_prompt",
    "organization_usage": "deny",
    "par_request_expiry": 305,
    "refresh_token": {
      "expiration_type": "non-expiring",
      "rotation_type": "non-rotating",
      "idle_token_lifetime": 2,
      "infinite_idle_token_lifetime": false,
      "infinite_token_lifetime": true,
      "leeway": 0,
      "policies": [
        {
          "audience": "<string>",
          "scope": [
            "<string>"
          ]
        }
      ],
      "token_lifetime": 78894000
    },
    "require_proof_of_possession": false,
    "require_pushed_authorization_requests": false,
    "resource_server_identifier": "<string>",
    "session_transfer": {
      "allow_refresh_token": false,
      "allowed_authentication_methods": [],
      "can_create_session_transfer_token": false,
      "delegation": {
        "allow_delegated_access": false,
        "enforce_device_binding": "ip"
      },
      "enforce_cascade_revocation": true,
      "enforce_device_binding": "ip",
      "enforce_online_refresh_tokens": true
    },
    "signed_request_object": {
      "credentials": [
        {
          "id": "<string>"
        }
      ],
      "required": false
    },
    "signing_keys": [
      {
        "cert": "",
        "pkcs7": "",
        "subject": ""
      }
    ],
    "skip_non_verifiable_callback_uri_confirmation_prompt": true,
    "sso": false,
    "sso_disabled": false,
    "tenant": "",
    "token_endpoint_auth_method": "none",
    "token_exchange": {
      "allow_any_profile_of_type": []
    },
    "token_quota": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    },
    "web_origins": [
      "<string>"
    ]
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

fields · string

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

include_fields · boolean

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

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: x >= 0

per_page · integer

Número de resultados por página. El valor predeterminado es 50; el valor máximo es 100

Rango requerido: 0 <= x <= 100

include_totals · boolean

Devuelve los resultados dentro de un objeto que contiene el número total de resultados (true) o como un arreglo directo de resultados (false, valor predeterminado).

from · string

Id opcional a partir del cual iniciar la selección.

take · integer

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

Rango requerido: 1 <= x <= 100

is_global · boolean

Filtro opcional sobre el parámetro global del cliente.

is_first_party · boolean

Filtro opcional según si un cliente es o no first-party.

app_type · string

Filtro opcional por una lista de tipos de aplicación separada por comas.

external_client_id · string

Filtro opcional por el URI del Client ID Metadata Document para clientes registrados en CIMD.

Required string length: 1 - 120

q · string

Consulta avanzada con sintaxis de Lucene.
Consultas permitidas:

• client_grant.organization_id:{organization_id}
• client_grant.allow_any_organization:true

Restricciones adicionales:

• No se puede usar en combinación con otros filtros
• Requiere usar los parámetros de paginación from y take (paginación por punto de control)
• Se aplican límites de frecuencia reducidos. Consulte Rate Limit Configurations

Nota: Es posible que las actualizaciones recientes no se reflejen de inmediato en los resultados de la consulta

Respuesta

200

application/json

Clientes recuperados correctamente.

Option 1 · object[]

Option 2 · object

Option 3 · object

addons · object

Complementos habilitados para este cliente y sus configuraciones asociadas.

Show child attributes

allowed_clients · string[]

Lista de clientes permitidos e id de API a los que se les permite hacer solicitudes de delegation. Si está vacía, significa que todos sus clientes están permitidos.

allowed_logout_urls · string[]

Lista de URL separadas por comas válidas para redirigir después de cerrar sesión en Auth0. Se permiten comodines para subdominios.

allowed_origins · string[]

Lista de URL separadas por comas permitidas para realizar solicitudes desde JavaScript a la API de Auth0 (normalmente se usa con CORS). De forma predeterminada, se permitirán todas sus URL de devolución de llamada. Este campo le permite introducir otros orígenes si es necesario. También puede usar comodines en el nivel de subdominio (por ejemplo, https://*.contoso.com). Las cadenas de consulta y la información de hash no se tienen en cuenta al validar estas URL.

app_type · enum<string>

El tipo de aplicación que representa este cliente

Opciones disponibles: native, spa, regular_web, non_interactive, resource_server, express_configuration, rms, box, cloudbees, concur, dropbox, mscrm, echosign, egnyte, newrelic, office365, salesforce, sentry, sharepoint, slack, springcm, zendesk, zoom, sso_integration, oag

async_approval_notification_channels · enum<string>[]

Lista de canales de notificación para contactar con el usuario cuando se requiere su aprobación. Los valores válidos son guardian-push, email.

Minimum array length: 1

Opciones disponibles: guardian-push, email

callbacks · string[]

Lista de URL separadas por comas permitidas para que Auth0 las use como URL de devolución de llamada al cliente después de la autenticación.

client_aliases · string[]

Lista de audiencias/realms para el protocolo SAML. La usa el addon wsfed.

client_authentication_methods · object

Define los métodos de autenticación del cliente.

Show child attributes

client_id · string · predeterminado: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID de este cliente.

client_metadata · object

Metadatos asociados al cliente, en forma de objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 10 propiedades de metadatos. Los nombres de campo (máx. 255 caracteres) son alfanuméricos y solo pueden incluir los siguientes caracteres especiales: :,-+=_*?"/\()<>@\t[Tab] [Space]

client_secret · string · predeterminado: MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H

Secreto del cliente (que no debe hacerse público).

compliance_level · enum<string> | null

Define el nivel de cumplimiento de este cliente, que puede restringir sus capacidades.

Opciones disponibles: none, fapi1_adv_pkj_par, fapi1_adv_mtls_par, fapi2_sp_pkj_mtls, fapi2_sp_mtls_mtls, null

cross_origin_authentication · boolean

Indica si este cliente puede usarse para realizar solicitudes de autenticación entre orígenes (true) o si no tiene permitido realizar dichas solicitudes (false).

cross_origin_loc · string<url>

URL de la ubicación de su sitio donde se realiza la verificación entre orígenes para el flujo de autenticación entre orígenes al autenticar en su propio dominio en lugar de la hosted login page de Auth0.

custom_login_page · string · predeterminado: ""

El contenido (HTML, CSS, JS) de la página de inicio de sesión personalizada.

custom_login_page_on · boolean · predeterminado: true

Indica si se debe usar una página de inicio de sesión personalizada (true) o la página de inicio de sesión predeterminada (false).

custom_login_page_preview · string · predeterminado: ""

El contenido (HTML, CSS, JS) de la página de inicio de sesión personalizada. (Se usa en las vistas previas)

default_organization · object

Define el ID de Organización predeterminado y los flujos.

Show child attributes

description · string · predeterminado: ""

Descripción de texto libre de este cliente (longitud máxima: 140 caracteres).

encryption_key · object

Cifrado usado para las respuestas de WsFed con este cliente.

Show child attributes

express_configuration · object

Configuración específica de la aplicación para usar con la función Express Configuration de OIN.

Show child attributes

external_client_id · string<absolute-https-uri-or-empty>

Un identificador alternativo del cliente que se usará durante los flujos de autorización. Solo admite identificadores de cliente basados en CIMD.

external_metadata_created_by · enum<string>

Indica quién creó el cliente de metadatos externos. El valor admin indica que el cliente se registró mediante la Management API. El valor client indica que el cliente se registró dinámicamente. Este campo solo está presente cuando se establece external_metadata_type.

Opciones disponibles: admin, client

external_metadata_type · enum<string>

Indica el tipo de metadatos externos usados para registrar el cliente. Este campo se omite para los clientes normales. El valor cimd identifica a los clientes registrados mediante un documento de metadatos de ID de cliente. El valor dcr identifica a los clientes registrados mediante Dynamic Client Registration.

Opciones disponibles: cimd, dcr

fedcm_login · any

form_template · string · predeterminado: ""

Plantilla de formulario HTML que se usará para WS-Federation.

global · boolean · predeterminado: false

Si este es su cliente global "All Applications", que representa la configuración heredada del inquilino (true), o un cliente normal (false).

grant_types · string[]

Lista de tipo de concesión compatibles con esta aplicación. Puede incluir authorization_code, implicit, refresh_token, client_credentials, password, http://auth0.com/oauth/grant-type/password-realm, http://auth0.com/oauth/grant-type/mfa-oob, http://auth0.com/oauth/grant-type/mfa-otp, http://auth0.com/oauth/grant-type/mfa-recovery-code, urn:openid:params:grant-type:ciba, urn:ietf:params:oauth:grant-type:device_code y urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token.

initiate_login_uri · string<absolute-https-uri-with-placeholders-or-empty>

URI de inicio de sesión; debe usar https

is_first_party · boolean · predeterminado: false

Indica si este cliente es de primera parte (true) o no (false).

is_token_endpoint_ip_header_trusted · boolean · predeterminado: false

Si es true, confíe en que la IP especificada en el encabezado auth0-forwarded-for es la IP del usuario final para la protección contra fuerza bruta en el token endpoint.

jwks_uri · string<absolute-https-uri-or-empty>

URL del conjunto de claves web JSON (JWKS) que contiene las claves públicas usadas para la autenticación private_key_jwt. Solo está presente para clientes CIMD que usan autenticación private_key_jwt.

jwt_configuration · object

Configuración relacionada con los JWT del cliente.

Show child attributes

logo_uri · string

URL del logotipo que se mostrará para este cliente. El tamaño recomendado es de 150 x 150 píxeles.

mobile · object

Configuración adicional para aplicaciones móviles nativas.

Show child attributes

my_organization_configuration · object · EA

Configuración relacionada con My Organization Configuration para el cliente.

Show child attributes

name · string · predeterminado: My application

Nombre de este cliente (longitud mínima: 1 carácter; no permite < ni >).

native_social_login · any

oidc_conformant · boolean · predeterminado: false

Indica si este cliente cumple las especificaciones estrictas de OIDC (true) o usa funciones heredadas (false).

oidc_logout · object

Configuración del logout por canal secundario de OIDC

Show child attributes

organization_discovery_methods · enum<string>[] · EA

Define los métodos disponibles para detectar la organización durante pre_login_prompt. Los usuarios pueden descubrir su organización mediante email, organization_name o ambos.

Minimum array length: 1

Método para detectar organizaciones durante pre_login_prompt. email permite a los usuarios encontrar su organización introduciendo su dirección de correo electrónico y realizando una coincidencia de dominio, mientras que organization_name requiere que los usuarios introduzcan directamente el nombre de la organización. Estos métodos pueden combinarse.

Opciones disponibles: email, organization_name

organization_require_behavior · enum<string> · predeterminado: no_prompt

Define cómo proceder durante una transacción de autenticación cuando client.organization_usage: 'require'. Puede ser no_prompt (predeterminado), pre_login_prompt o post_login_prompt. post_login_prompt requiere oidc_conformant: true.

Opciones disponibles: no_prompt, pre_login_prompt, post_login_prompt

organization_usage · enum<string> · predeterminado: deny

Define cómo proceder durante una transacción de autenticación con respecto a una organización. Puede ser deny (predeterminado), allow o require.

Opciones disponibles: deny, allow, require

par_request_expiry · integer | null

Especifica cuánto tiempo, en segundos, sigue siendo válida una URI de Pushed Authorization Request

Rango requerido: 10 <= x <= 600

redirection_policy · enum<string> · GA

Controla si Auth0 redirige a los usuarios a la URL de devolución de llamada de la aplicación cuando se producen errores de autenticación o en flujos de verificación de correo electrónico. open_redirect_protection muestra una página de error en lugar de redirigir y oculta el dominio de devolución de llamada en las plantillas de correo electrónico. allow_always habilita el comportamiento de redirección estándar. El valor predeterminado es open_redirect_protection para clientes de terceros. Solo se aplica cuando is_first_party es false y third_party_security_mode es strict. Para obtener más información, consulta Protección de redirección.

Opciones disponibles: allow_always, open_redirect_protection

refresh_token · object

Configuración del token de actualización

Show child attributes

require_proof_of_possession · boolean · predeterminado: false

Hace obligatorio el uso de Proof-of-Possession para este cliente

require_pushed_authorization_requests · boolean · predeterminado: false

Hace obligatorio el uso de Pushed Authorization Request para este cliente

resource_server_identifier · string

El identificador del servidor de recursos al que está vinculado este cliente.

session_transfer · object

Configuración de SSO de nativo a web

Show child attributes

signed_request_object · object

Configuración de solicitudes de autorización protegidas con JWT (JAR).

Show child attributes

signing_keys · object[] | null

Certificados de firma asociados a este cliente.

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean

Controla si se muestra una pantalla de confirmación durante los flujos de inicio de sesión cuando el Redirect URI usa URL de devolución de llamada no verificables (por ejemplo, un esquema de URI personalizado como myapp:// o localhost). Si se establece en true, no se mostrará una pantalla de confirmación. Recomendamos establecerlo en false para mejorar la protección frente a aplicaciones maliciosas. Consulte https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation para obtener más información.

sso · boolean · predeterminado: false

Se aplica solo a clientes SSO y determina si Auth0 gestionará el inicio de sesión único (true) o si lo hará el Proveedor de identidad (false).

sso_disabled · boolean · predeterminado: false

Indica si el inicio de sesión único está deshabilitado (true) o habilitado (true). El valor predeterminado es true.

tenant · string · predeterminado: ""

Nombre del inquilino al que pertenece este cliente.

third_party_security_mode · enum<string> · GA

Modo de seguridad para clientes de terceros. strict aplica controles de seguridad mejorados: alineación con OAuth 2.1, autorización explícita de API y un conjunto seleccionado de funcionalidades compatibles. permissive conserva el comportamiento preexistente y solo está disponible para inquilinos con uso previo de clientes de terceros. Se establece al crearlo y no puede modificarse.

Opciones disponibles: strict, permissive

token_endpoint_auth_method · enum<string> · predeterminado: none

Define el método de autenticación solicitado para el endpoint de token. Puede ser none (cliente público sin secreto de cliente), client_secret_post (el cliente usa parámetros HTTP POST) o client_secret_basic (el cliente usa HTTP Basic).

Opciones disponibles: none, client_secret_post, client_secret_basic

token_exchange · object · GA

Configuración para el intercambio de tokens.

Show child attributes

token_quota · object · EA

Show child attributes

web_origins · string[]

Lista separada por comas de orígenes permitidos para usar con autenticación entre orígenes, flujo de dispositivo y modo de respuesta web_message.