Obtenir les clients
Récupérer les clients (applications et intégrations SSO) correspondant aux filtres fournis. Il est également possible de préciser une liste de champs à inclure ou à exclure. Pour en savoir plus, consultez Applications in Auth0 et Single Sign-On.
- Les éléments suivants peuvent être récupérés avec n’importe quelle portée :
client_id,app_type,nameetdescription. - Les propriétés suivantes ne peuvent être récupérées qu’avec la portée
read:clientsouread: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_on,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. - Les propriétés suivantes ne peuvent être récupérées qu’avec la
portée
read:client_keysouread:client_credentials:encryption_key,encryption_key.pub,encryption_key.cert,client_secret,client_authentication_methodsetsigning_key.
Autorisations
Scopes
Paramètres de requête
Filtre facultatif selon l’URI du Client ID Metadata Document pour les clients enregistrés par CIMD.
1 - 120Filtre facultatif selon l’agent associé au client.
Restrictions supplémentaires :
- Ne peut pas être utilisée en combinaison avec d’autres filtres
- Seuls les paramètres fields, include_fields, page, per_page et include_totals sont pris en charge avec ce filtre
- La pagination par point de reprise (from, take) n’est pas prise en charge
Requête avancée utilisant la syntaxe Lucene.
Requêtes permises :
- client_grant.organization_id:{organization_id}
- client_grant.allow_any_organization:true
- Ne peut pas être combinée à d’autres filtres
- Nécessite l’utilisation des paramètres de pagination from et take (pagination par point de reprise)
- Des limites anti-attaques réduites s’appliquent. Voir Configurations des limites anti-attaques
Réponse
Clients récupérés avec succès.
- Option 1 · object[]
- Option 2 · object
- Option 3 · object
Le type d’application que ce client représente
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 Indique si ce client est conforme aux spécifications strictes d’OIDC (true) ou s’il utilise des fonctionnalités héritées (false).
Liste d’URL séparées par des virgules autorisées à effectuer des requêtes JavaScript vers l’API Auth0 (généralement utilisée avec CORS). Par défaut, toutes vos URL de rappel seront autorisées. Ce champ vous permet de saisir d’autres origines au besoin. Vous pouvez aussi utiliser des caractères génériques au niveau du sous-domaine (p. ex. https://*.contoso.com). Les chaînes de requête et les informations de hachage ne sont pas prises en compte lors de la validation de ces URL.
Liste d’origines autorisées, séparées par des virgules, à utiliser avec la Cross-Origin Authentication, le Device Flow et le mode de réponse par message Web.
Liste des types d’octroi pris en charge pour cette application. Peut inclure 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 et urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token.
Définit la méthode d’authentification demandée pour le point de terminaison des jetons. Peut être none (client public sans client secret), client_secret_post (le client utilise des paramètres HTTP POST) ou client_secret_basic (le client utilise HTTP Basic).
none, client_secret_post, client_secret_basic Metadata associées au client, sous la forme d’un object contenant des valeurs String (max. 255 caractères). Un maximum de 10 properties de metadata est autorisé. Les field names (max. 255 caractères) sont alphanumériques et peuvent uniquement inclure les caractères spéciaux suivants : :,-+=_*?"/()<>@ [Tab] [Space]
Définit comment procéder pendant une transaction d’authentification lorsque client.organization_usage: 'require'. Peut être no_prompt (par défaut), pre_login_prompt ou post_login_prompt. post_login_prompt exige oidc_conformant: true.
no_prompt, pre_login_prompt, post_login_prompt Définit les méthodes offertes pour la découverte de l’organisation durant le pre_login_prompt. Les utilisateurs peuvent découvrir leur organisation à l’aide de email, de organization_name ou des deux.
1Méthode de découverte des organisations pendant pre_login_prompt. email permet aux utilisateurs de trouver leur organisation en saisissant leur adresse courriel et en effectuant une correspondance de domaine, tandis que organization_name exige qu’ils saisissent directement le nom de l’organisation. Ces méthodes peuvent être combinées.
email, organization_name Détermine si un message de confirmation est affiché durant les flux de connexion lorsque l’URI de redirection utilise des URI de rappel non vérifiables (par exemple, un schéma d’URI personnalisé comme myapp:// ou localhost).
Si la valeur est true, aucun message de confirmation ne sera affiché. Nous recommandons de définir cette valeur à false afin d’améliorer la protection contre les applications malveillantes.
Consultez https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation pour en savoir plus.
Indique si la liaison réseau doit être appliquée lors de l’utilisation d’un jeton de transfert de session anonyme. Si la valeur est 'ip', le jeton doit être utilisé à partir de la même adresse IP que celle de l’émetteur. Si la valeur est 'asn', le jeton doit être utilisé à partir du même NSA que celui de l’émetteur. Si la valeur est 'none', la liaison n’est pas appliquée. La valeur par défaut est ip.
ip, asn, none Mode de sécurité pour les clients tiers. strict applique des contrôles de sécurité renforcés : alignement sur OAuth 2.1, autorisation explicite de l’API et ensemble sélectionné de fonctionnalités prises en charge. permissive conserve le comportement préexistant et n’est offert qu’aux tenants ayant déjà utilisé des clients tiers. Il est défini à la création et ne peut pas être modifié.
strict, permissive Détermine si Auth0 redirige les utilisateurs vers l’URL de rappel de l’application en cas d’erreur d’authentification ou dans les flux de vérification du courriel. open_redirect_protection affiche plutôt une page d’erreur que d’effectuer une redirection et masque le domaine de rappel dans les modèles de courriel. allow_always active le comportement de redirection standard. La valeur par défaut est open_redirect_protection pour les clients third-party. S’applique uniquement lorsque is_first_party est false et que third_party_security_mode est strict. Pour en savoir plus, consultez la protection contre les redirections.
allow_always, open_redirect_protection Indique le type de métadonnées externes utilisé pour enregistrer le client. Ce champ est omis pour les clients ordinaires. La valeur cimd identifie les clients enregistrés au moyen d’un Client ID Metadata Document. La valeur dcr identifie les clients enregistrés au moyen de Dynamic Client Registration.
cimd, dcr Indique qui a créé le client de métadonnées externes. La valeur admin indique que le client a été enregistré au moyen de la Management API. La valeur client indique que le client a été enregistré dynamiquement. Ce champ n’est présent que lorsque external_metadata_type est défini.
admin, client Indique si le document de métadonnées de l’identifiant du client à l’adresse external_client_id est actuellement accessible. Pour les clients dont la valeur de external_metadata_created_by est client, l’état est calculé à partir du document; pour admin, il est toujours available. Si l’état est absent, il est considéré comme available.
available, unavailable