Lister les applications

Récupère les applications (applications et intégrations SSO) correspondant aux filtres fournis. Il est aussi 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 quel scope : client_id, app_type, name et description.
• Les propriétés suivantes peuvent être récupérées uniquement avec le scope read:clients ou 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.
• Les propriétés suivantes peuvent être récupérées uniquement avec les scopes read:client_keys ou read:client_credentials : encryption_key, encryption_key.pub, encryption_key.cert, client_secret, client_authentication_methods et 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>"
    ]
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez ce champ vide pour récupérer tous les champs.

include_fields · boolean

Indique si les champs précisés doivent être inclus (true) ou exclus (false).

page · integer

Indice de la page de résultats à retourner. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La valeur par défaut est de 50 et la valeur maximale est de 100

Plage requise: 0 <= x <= 100

include_totals · boolean

Retourne les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, par défaut).

from · string

Id facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est de 50.

Plage requise: 1 <= x <= 100

is_global · boolean

Filtre facultatif sur le paramètre global de l’application.

is_first_party · boolean

Filtre facultatif indiquant si une application est propriétaire ou non.

app_type · string

Filtre facultatif selon une liste de types d’application séparés par des virgules.

external_client_id · string

Filtre facultatif selon l’URI du Client ID Metadata Document pour les applications enregistrées avec CIMD.

Required string length: 1 - 120

q · string

Requête avancée en syntaxe Lucene.
Requêtes autorisées :

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

Restrictions supplémentaires :

• Ne peut pas être utilisée en combinaison avec d’autres filtres
• Nécessite l’utilisation des paramètres de pagination from et take (pagination par point de contrôle)
• Des limites de débit réduites s’appliquent. Consultez Rate Limit Configurations

Remarque : Les mises à jour récentes peuvent ne pas être reflétées immédiatement dans les résultats de la requête

Réponse

200

application/json

Applications récupérées avec succès.

Option 1 · object[]

Option 2 · object

Option 3 · object

addons · object

Modules complémentaires activés pour ce client et leurs configurations associées.

Show child attributes

allowed_clients · string[]

Liste des applications autorisées et des id d’API autorisés à effectuer des requêtes de délégation. Si elle est vide, toutes vos applications sont autorisées.

allowed_logout_urls · string[]

Liste d’URL séparées par des virgules vers lesquelles la redirection après la déconnexion d’Auth0 est autorisée. Les caractères génériques sont autorisés pour les sous-domaines.

allowed_origins · string[]

Liste d’URL séparées par des virgules autorisées à envoyer des requêtes JavaScript à l’API Auth0 (généralement utilisée avec CORS). Par défaut, toutes vos URL de callback 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 (par 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.

app_type · enum<string>

Le type d’application que représente ce client

Options 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>[]

Tableau des canaux de notification pour communiquer avec l’utilisateur lorsque son approbation est requise. Les valeurs valides sont guardian-push, email.

Minimum array length: 1

Options disponibles: guardian-push, email

callbacks · string[]

Liste d’URL séparées par des virgules et sur liste blanche qu’Auth0 peut utiliser comme URL de callback vers l’application après l’authentification.

client_aliases · string[]

Liste des audiences/realms pour le protocole SAML. Utilisée par l’addon wsfed.

client_authentication_methods · object

Définit les méthodes d’authentification du client.

Show child attributes

client_id · string · défaut: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID de cette application.

client_metadata · object

Métadonnées associées à l’application, sous la forme d’un objet contenant des valeurs de type chaîne de caractères (max. 255 caractères). Maximum de 10 propriétés de métadonnées autorisées. Les noms de champ (max. 255 caractères) sont alphanumériques et peuvent inclure uniquement les caractères spéciaux suivants : :,-+=_*?"/()<>@ [Tab] [espace]

client_secret · string · défaut: MG_TNT2ver-SylNat-_VeMmd-4m0Waba0jr1troztBniSChEw0glxEmgEi2Kw40H

Secret client (que vous ne devez pas rendre public).

compliance_level · enum<string> | null

Définit le niveau de conformité de cette application, ce qui peut en restreindre les capacités.

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

cross_origin_authentication · boolean

Indique si cette application peut être utilisée pour effectuer des requêtes d’authentification inter-origine (true) ou si elle n’est pas autorisée à en effectuer (false).

cross_origin_loc · string<url>

URL de l’emplacement sur votre site où s’effectue la vérification inter-origine pour le flux d’authentification inter-origine lorsque vous utilisez l’authentification sur votre propre domaine plutôt que la page de connexion hébergée par Auth0.

custom_login_page · string · défaut: ""

Le contenu (HTML, CSS, JS) de la page de connexion personnalisée.

custom_login_page_on · boolean · défaut: true

Indique si une page de connexion personnalisée doit être utilisée (true) ou si la page de connexion par défaut doit l’être (false).

custom_login_page_preview · string · défaut: ""

Le contenu (HTML, CSS, JS) de la page de connexion personnalisée. (Utilisé dans les aperçus)

default_organization · object

Définit l’ID d’Organisation par défaut et les flux.

Show child attributes

description · string · défaut: ""

Description en texte libre de cette application (longueur maximale : 140 caractères).

encryption_key · object

Chiffrement utilisé pour les réponses WsFed avec cette application.

Show child attributes

express_configuration · object

Configuration propre à l’application pour la fonctionnalité Configuration Express OIN.

Show child attributes

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

Un autre identifiant d’application à utiliser pendant les flux d’autorisation. Seuls les identifiants d’application basés sur CIMD sont pris en charge.

external_metadata_created_by · enum<string>

Indique qui a créé l’application avec métadonnées externes. La valeur admin indique que l’application a été enregistrée au moyen de la Management API. La valeur client indique que l’application a été enregistrée dynamiquement. Ce champ n’est présent que lorsque external_metadata_type est défini.

Options disponibles: admin, client

external_metadata_type · enum<string>

Indique le type de métadonnées externes utilisé pour enregistrer l’application. Ce champ est omis pour les applications ordinaires. La valeur cimd identifie les applications enregistrées au moyen d’un document de métadonnées d’ID client. La valeur dcr identifie les applications enregistrées au moyen de l’Enregistrement dynamique des applications.

Options disponibles: cimd, dcr

fedcm_login · any

form_template · string · défaut: ""

Modèle de formulaire HTML à utiliser pour WS-Federation.

global · boolean · défaut: false

Indique s’il s’agit de votre application globale « All Applications » représentant les anciens paramètres du locataire (true) ou d’une application standard (false).

grant_types · string[]

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.

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

URI d’initiation de connexion, doit utiliser HTTPS

is_first_party · boolean · défaut: false

Indique si cette application est une application propriétaire (true) ou non (false).

is_token_endpoint_ip_header_trusted · boolean · défaut: false

Si true, considère que l’adresse IP indiquée dans l’en-tête auth0-forwarded-for est celle de l’utilisateur final pour la protection contre les attaques par force brute au point de terminaison de jeton.

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

URL de l’ensemble de clés JSON Web (JWKS) contenant les clés publiques utilisées pour l’authentification private_key_jwt. Présente uniquement pour les clients CIMD qui utilisent l’authentification private_key_jwt.

jwt_configuration · object

Configuration liée aux JWT pour l’application.

Show child attributes

logo_uri · string

URL du logo à afficher pour cette application. La taille recommandée est de 150 x 150 pixels.

mobile · object

Configuration supplémentaire pour les applications mobiles natives.

Show child attributes

my_organization_configuration · object · EA

Configuration liée à My Organization Configuration pour l’application.

Show child attributes

name · string · défaut: My application

Nom de cette application (longueur minimale : 1 caractère, n’autorise pas < ni >).

native_social_login · any

oidc_conformant · boolean · défaut: false

Indique si cette application est conforme aux spécifications OIDC strictes (true) ou si elle utilise des fonctionnalités anciennes (false).

oidc_logout · object

Configuration de la déconnexion OIDC par canal arrière

Show child attributes

organization_discovery_methods · enum<string>[] · EA

Définit les méthodes disponibles pour la découverte de l’organisation pendant pre_login_prompt. Les utilisateurs peuvent découvrir leur organisation à l’aide de email, de organization_name ou des deux.

Minimum array length: 1

Méthode de découverte des organisations pendant pre_login_prompt. email permet aux utilisateurs de trouver leur organisation en entrant leur adresse de courriel et en faisant correspondre le domaine, tandis que organization_name oblige les utilisateurs à entrer directement le nom de l’organisation. Ces méthodes peuvent être combinées.

Options disponibles: email, organization_name

organization_require_behavior · enum<string> · défaut: no_prompt

Définit comment procéder pendant une transaction d’authentification lorsque client.organization_usage: 'require'. Les valeurs possibles sont no_prompt (par défaut), pre_login_prompt ou post_login_prompt. post_login_prompt exige oidc_conformant: true.

Options disponibles: no_prompt, pre_login_prompt, post_login_prompt

organization_usage · enum<string> · défaut: deny

Définit comment procéder pendant une transaction d’authentification en ce qui concerne une organisation. Les valeurs possibles sont deny (par défaut), allow ou require.

Options disponibles: deny, allow, require

par_request_expiry · integer | null

Spécifie pendant combien de temps, en secondes, une URI de requête d’autorisation poussée demeure valide

Plage requise: 10 <= x <= 600

redirection_policy · enum<string> · GA

Contrôle si Auth0 redirige les utilisateurs vers l’URL de rappel de l’application en cas d’erreurs 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 applications tierces. S’applique uniquement lorsque is_first_party est false et que third_party_security_mode est strict. Pour en savoir plus, consultez Protection contre les redirections.

Options disponibles: allow_always, open_redirect_protection

refresh_token · object

Configuration des jetons d’actualisation

Show child attributes

require_proof_of_possession · boolean · défaut: false

Rend obligatoire l’utilisation de Proof-of-Possession pour cette application

require_pushed_authorization_requests · boolean · défaut: false

Rend obligatoire l’utilisation des requêtes d’autorisation poussée pour cette application

resource_server_identifier · string

L’identifiant du serveur de ressources auquel cette application est associée.

session_transfer · object

Configuration du SSO natif vers le Web

Show child attributes

signed_request_object · object

Paramètres des requêtes d’autorisation sécurisées par JWT (JAR).

Show child attributes

signing_keys · object[] | null

Certificats de signature associés à cette application.

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean

Contrôle si une invite de confirmation est affichée pendant les flux de connexion lorsque l’URI de redirection utilise des URI de callback non vérifiables (par exemple, un schéma d’URI personnalisé comme myapp:// ou localhost). Si la valeur est true, aucune invite de confirmation ne sera affichée. 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.

sso · boolean · défaut: false

S’applique uniquement aux applications SSO et détermine si Auth0 gérera l’authentification unique (true) ou si ce sera le fournisseur d’identité (false).

sso_disabled · boolean · défaut: false

Indique si l’authentification unique est désactivée (true) ou activée (true). La valeur par défaut est true.

tenant · string · défaut: ""

Nom du locataire auquel cette application appartient.

third_party_security_mode · enum<string> · GA

Mode de sécurité pour les applications tierces. strict applique des contrôles de sécurité renforcés : alignement sur OAuth 2.1, autorisation explicite des API et ensemble sélectionné de fonctionnalités prises en charge. permissive préserve le comportement existant et n’est disponible que pour les locataires ayant déjà utilisé des applications tierces. Cette valeur est définie à la création et ne peut pas être modifiée.

Options disponibles: strict, permissive

token_endpoint_auth_method · enum<string> · défaut: none

Définit la méthode d’authentification demandée pour le point de terminaison de jeton. Les valeurs possibles sont none (application publique sans secret client), client_secret_post (l’application utilise des paramètres HTTP POST) ou client_secret_basic (l’application utilise HTTP Basic).

Options disponibles: none, client_secret_post, client_secret_basic

token_exchange · object · GA

Configuration de l’échange de jetons.

Show child attributes

token_quota · object · EA

Show child attributes

web_origins · string[]

Liste d’origines autorisées à utiliser avec l’authentification inter-origine, le flux d’appareil et le mode de réponse web_message.