Mettre à jour un client par ID

Met à jour les paramètres d’un client. Pour en savoir plus, consultez Applications in Auth0 et Single Sign-On.

Remarques :

• Les attributs client_secret et signing_key ne peuvent être mis à jour qu’avec la portée update:client_keys.
• Les propriétés client_authentication_methods et token_endpoint_auth_method s’excluent mutuellement. Utilisez client_authentication_methods pour configurer le client avec la méthode d’authentification Private Key JWT. Sinon, utilisez token_endpoint_auth_method pour configurer le client avec un client secret (basic ou post) ou sans méthode d’authentification (none).
• Lorsque vous utilisez client_authentication_methods pour configurer le client avec la méthode d’authentification Private Key JWT, indiquez uniquement les ID d’identifiants d’authentification générés lors de la création des identifiants d’authentification sur le client.
• Pour configurer client_authentication_methods, la portée update:client_credentials est requise.
• Pour configurer client_authentication_methods, la propriété jwt_configuration.alg doit être définie à RS256.
• Pour remplacer la propriété is_first_party d’un client par false, les propriétés organization_usage et organization_require_behavior doivent être désactivées.

PATCH https://{tenantDomain}/api/v2/clients/{id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Clients.UpdateAsync(
            id: "id",
            request: new UpdateClientRequestContent()
        );
    }

}

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": [],
  "b2b_integration_configuration": {
    "sso_profiles": [
      "<string>"
    ]
  },
  "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": [
      "client_credentials"
    ],
    "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": {
    "google": {
      "is_enabled": false
    }
  },
  "form_template": "",
  "global": false,
  "grant_types": [
    "<string>"
  ],
  "identity_assertion_authorization_grant": {
    "active": false
  },
  "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>",
    "invitation_landing_client_id": "<string>",
    "user_attribute_profile_id": "<string>"
  },
  "name": "My application",
  "native_social_login": {
    "apple": {
      "enabled": false
    },
    "facebook": {
      "enabled": false
    },
    "google": {
      "enabled": false
    }
  },
  "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
    }
  },
  "token_vault_privileged_access": {
    "credentials": [
      {
        "id": "<string>"
      }
    ],
    "grants": [
      {
        "connection": "<string>",
        "scopes": [
          "<string>"
        ]
      }
    ],
    "ip_allowlist": [
      "127.0.0.1"
    ]
  },
  "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 chemin

id · string · requis

ID du client à mettre à jour.

Corps

application/jsonapplication/x-www-form-urlencoded

addons · object

Modules complémentaires activés pour ce client et leur configuration associée.

Show child attributes

allowed_clients · string[]

ID des clients qui seront autorisés à effectuer des requêtes de Delegation. Clients qui seront autorisés à effectuer une requête de Delegation. Par défaut, tous vos clients seront autorisés. Ce champ vous permet de préciser des clients particuliers

Minimum string length: 1

allowed_logout_urls · string<url-with-placeholders>[]

URL valides de redirection après le logout d’Auth0

allowed_origins · string<url-with-placeholders>[]

Ensemble d’URL représentant des origines valides pour CORS

app_type · enum<string>

Le type d’application que ce client représente

Options disponibles: native, spa, regular_web, non_interactive, resource_server, express_configuration, b2b_integration, 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>[] | null

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

b2b_integration_configuration · object | null · beta

Configuration des clients d’intégration B2B.

Show child attributes

callbacks · string<callback-url>[]

Ensemble d’URL valides pour le rappel depuis Auth0 lors de l’authentification des utilisateurs

client_aliases · string[]

Liste des audiences pour le protocole SAML

Minimum string length: 1

client_authentication_methods · object | null

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

Show child attributes

client_metadata · object

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]

client_secret · string

Le secret utilisé pour signer les jetons du client

Minimum string length: 1

compliance_level · enum<string> | null

Définit le niveau de conformité pour ce client, ce qui peut restreindre ses 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

true si ce client peut être utilisé pour effectuer des requêtes de cross-origin authentication, false sinon, si le cross-origin est désactivé

cross_origin_loc · string<url-or-null> | null

URL de l’emplacement sur votre site où la vérification inter-origine a lieu pour le flux de cross-origin authentication lorsque l’authentification est effectuée sur votre propre domain plutôt que sur la hosted login page d’Auth0.

custom_login_page · string

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

custom_login_page_on · boolean

true si la custom login page doit être utilisée, false sinon.

custom_login_page_preview · string

default_organization · object | null

Définit l’ID d’Organization par défaut et les flows.

Show child attributes

description · string

Description libre de l’objectif du client. (Longueur maximale : 140 caractères)

Maximum string length: 140

encryption_key · object | null

La clé de chiffrement du client

Show child attributes

express_configuration · object | null

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

Show child attributes

fedcm_login · object | null · EA

Configurer les paramètres de connexion FedCM pour le nouveau Universal Login

Show child attributes

form_template · string

Modèle de formulaire pour le protocole WS-Federation

grant_types · string[]

Ensemble des grant types que le client est autorisé à utiliser. 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.

Minimum string length: 1

identity_assertion_authorization_grant · object | null · EA

Configuration de l’utilisation des ID-JAG pour l’accès interapplications.

Show child attributes

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

URI de connexion initiale; doit utiliser HTTPS

is_first_party · boolean · défaut: true

Indique si ce client est un client propriétaire ou non

is_token_endpoint_ip_header_trusted · boolean · défaut: false

Si true, considérer que l’IP indiquée dans le header auth0-forwarded-for est l’IP de l’end-user pour la protection contre les attaques par force brute sur le token endpoint.

jwt_configuration · object

Objet qui contient les paramètres liés à la façon dont les JWT sont créés

Show child attributes

logo_uri · string<absolute-uri-or-empty>

L’URL du logo du client (taille recommandée : 150x150)

mobile · object

Configuration liée aux applications mobiles natives

Show child attributes

my_organization_configuration · object | null · EA

Configuration liée à My Organization Configuration pour le client.

Show child attributes

name · string

Le nom du client. Doit contenir au moins un caractère. N’autorise pas '<' ni '>'.

Pattern: ^[^<>]+$

native_social_login · object | null

Configurer les paramètres de connexion sociale native

Show child attributes

oidc_backchannel_logout · object · deprecated

Configuration du logout backchannel OIDC (deprecated, au profit de oidc_logout)

Show child attributes

oidc_conformant · boolean · défaut: false

Indique si ce client sera conforme aux spécifications strictes d’OIDC

oidc_logout · object

Configuration du logout OIDC par canal arrière

Show child attributes

organization_discovery_methods · enum<string>[] | null · EA

Définit les méthodes disponibles pour la découverte de l’organisation pendant le pre_login_prompt. Les utilisateurs peuvent découvrir leur organisation par email, organization_name ou les 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 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.

Options disponibles: email, organization_name

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

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.

Options disponibles: no_prompt, pre_login_prompt, post_login_prompt, null

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

Définit comment procéder pendant une transaction d’authentification en ce qui concerne une organization. Peut être deny (par défaut), allow ou require.

Options disponibles: deny, allow, require, null

par_request_expiry · integer | null

Précise pendant combien de temps, en secondes, une URI de Pushed Authorization Request demeure valide

Plage requise: 10 <= x <= 600

redirection_policy · enum<string> · GA

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.

Options disponibles: allow_always, open_redirect_protection

refresh_token · object | null

Configuration du Refresh Token

Show child attributes

require_proof_of_possession · boolean · défaut: false

Rend l’utilisation de la Proof-of-Possession obligatoire pour ce client

require_pushed_authorization_requests · boolean · défaut: false

Rend l’utilisation des Pushed Authorization Requests obligatoire pour ce client

session_transfer · object | null

Configuration de Native to Web SSO

Show child attributes

signed_request_object · object

Paramètres de JWT-Secured Authorization Requests (JAR).

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean | null

Détermine si une invite de confirmation s’affiche pendant les login flows lorsque l’URI de redirection utilise des callback URI 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 s’affichera. Nous recommandons de définir cette option à false pour mieux vous protéger contre les applications malveillantes. Consultez https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation pour en savoir plus.

sso · boolean

true pour utiliser Auth0 au lieu du fournisseur d’identité afin d’effectuer l’authentification unique, false sinon (par défaut : false)

sso_disabled · boolean

true pour désactiver l’authentification unique, false sinon (par défaut : false)

third_party_security_mode · enum<string> · GA

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é.

Options disponibles: strict, permissive

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

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).

Options disponibles: none, client_secret_post, client_secret_basic, null

token_exchange · object | null · GA

Configuration de l’échange de jetons.

Show child attributes

token_quota · object | null · EA

Show child attributes

token_vault_privileged_access · object · EA

Paramètres de l’accès privilégié à Token Vault.

Show child attributes

web_origins · string<url-with-placeholders>[]

Ensemble d’URL représentant des origines Web valides à utiliser avec le mode de réponse web message

Réponse

200

application/json

Client mis à jour avec succès.

addons · object

Modules complémentaires activés pour ce client et leur configuration associée.

Show child attributes

allowed_clients · string[]

Liste des clients autorisés et des ID d’API autorisés à effectuer des requêtes de délégation. Vide signifie que tous vos clients sont autorisés.

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 wildcards 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 vers l’API Auth0 (habituellement utilisée avec CORS). Par défaut, toutes vos callback URLs seront autorisées. Ce champ vous permet de saisir d’autres origines au besoin. Vous pouvez aussi utiliser des wildcards au niveau des sous-domaines (par ex. : https://*.contoso.com). Les query strings 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 ce client représente

Options disponibles: native, spa, regular_web, non_interactive, resource_server, express_configuration, b2b_integration, 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

b2b_integration_configuration · object · beta

Configuration des clients d’intégration B2B.

Show child attributes

callbacks · string[]

Liste d’URL séparées par des virgules qu’Auth0 est autorisé à utiliser comme callback vers le client après l’authentification.

client_aliases · string[]

Liste des audiences/realms pour le protocole SAML. Utilisée par le module complémentaire wsfed.

client_authentication_methods · object | null

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

Show child attributes

client_id · string · défaut: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID de ce client.

client_metadata · object

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]

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

Client secret (que vous ne devez pas rendre public).

compliance_level · enum<string> | null

Définit le niveau de conformité pour ce client, ce qui peut restreindre ses 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 ce client peut être utilisé pour effectuer des requêtes d’authentification cross-origin (true) ou s’il n’est pas autorisé à en effectuer (false).

cross_origin_loc · string<url>

URL de l’emplacement sur votre site où s’effectue la vérification cross-origin pour le flux d’authentification cross-origin lorsque l’authentification est effectuée sur votre propre domaine plutôt que sur la hosted login page d’Auth0.

custom_login_page · string · défaut: ""

Le contenu (HTML, CSS, JS) de la custom login page.

custom_login_page_on · boolean · défaut: true

Indique si une custom login page doit être utilisée (true) ou si la login page fournie par défaut doit l’être (false).

custom_login_page_preview · string · défaut: ""

Le contenu (HTML, CSS, JS) de la custom login page. (Utilisé pour les aperçus)

default_organization · object | null

Définit l’ID d’Organization par défaut et les flows.

Show child attributes

description · string · défaut: ""

Description en texte libre de ce client (longueur maximale : 140 caractères).

encryption_key · object | null

Chiffrement utilisé pour les réponses WsFed avec ce client.

Show child attributes

express_configuration · object

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

Show child attributes

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

Un autre identifiant de client à utiliser pendant les authorization flows. Prend uniquement en charge les identifiants de client basés sur CIMD.

external_metadata_created_by · enum<string>

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.

Options disponibles: admin, client

external_metadata_type · enum<string>

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.

Options disponibles: cimd, dcr

fedcm_login · object · EA

Configurer les paramètres de connexion FedCM pour le nouveau Universal Login

Show child attributes

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 client global « All Applications », qui représente les anciens paramètres du tenant (true), ou d’un client ordinaire (false).

grant_types · string[]

Liste des grant types 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.

identity_assertion_authorization_grant · object · EA

Configuration relative à l’utilisation des ID-JAG pour Cross App Access.

Show child attributes

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

URI de connexion initiale; doit utiliser HTTPS

is_first_party · boolean · défaut: false

Indique si ce client est un client de première partie (true) ou non (false).

is_token_endpoint_ip_header_trusted · boolean · défaut: false

Si true, considère que l’IP indiquée dans l’en-tête auth0-forwarded-for est l’IP de l’utilisateur final aux fins de la protection contre les attaques par force brute au token endpoint.

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

URL du JSON Web Key Set (JWKS) contenant les clés publiques utilisées pour l’authentication private_key_jwt. Présente uniquement pour les clients CIMD qui utilisent l’authentication private_key_jwt.

jwt_configuration · object

Configuration liée aux JWT du client.

Show child attributes

logo_uri · string

URL du logo à afficher pour ce client. 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 à la configuration My Organization pour le client.

Show child attributes

name · string · défaut: My application

Nom de ce client (longueur minimale : 1 caractère; < et > ne sont pas permis).

native_social_login · object

Configurer les paramètres de connexion sociale native

Show child attributes

oidc_conformant · boolean · défaut: false

Indique si ce client est conforme aux spécifications OIDC strictes (true) ou s’il utilise des fonctionnalités Legacy (false).

oidc_logout · object

Configuration du logout OIDC par canal arrière

Show child attributes

organization_discovery_methods · enum<string>[] · EA

Définit les méthodes offertes pour la découverte de l’organisation pendant le 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 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.

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'. Peut être 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 organization. Peut être deny (par défaut), allow ou require.

Options disponibles: deny, allow, require

par_request_expiry · integer | null

Précise pendant combien de temps, en secondes, un URI de Pushed Authorization Request reste valide

Plage requise: 10 <= x <= 600

redirection_policy · enum<string> · GA

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.

Options disponibles: allow_always, open_redirect_protection

refresh_token · object | null

Configuration du Refresh Token

Show child attributes

require_proof_of_possession · boolean · défaut: false

Rend l’utilisation de Proof-of-Possession obligatoire pour ce client

require_pushed_authorization_requests · boolean · défaut: false

Rend l’utilisation de Pushed Authorization Requests obligatoire pour ce client

resource_server_identifier · string

L’identifiant du resource server auquel ce client est associé.

session_transfer · object | null

Configuration de Native to Web SSO

Show child attributes

signed_request_object · object

Paramètres de JWT-Secured Authorization Requests (JAR).

Show child attributes

signing_keys · object[] | null

Certificats de signature associés à ce client.

Show child attributes

skip_non_verifiable_callback_uri_confirmation_prompt · boolean

Détermine si une invite de confirmation s’affiche pendant les login flows lorsque l’URI de redirection utilise des callback URI 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 s’affichera. Nous recommandons de régler cette valeur à false pour mieux se protéger contre les applications malveillantes. Consultez https://auth0.com/docs/secure/security-guidance/measures-against-app-impersonation pour plus d’information.

sso · boolean · défaut: false

S’applique uniquement aux clients SSO et détermine si Auth0 gérera l’authentification unique (true) ou si ce sera l’Identity Provider (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 tenant auquel ce client appartient.

third_party_security_mode · enum<string> · GA

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é.

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 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).

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

token_vault_privileged_access · object · EA

Paramètres de l’accès privilégié à Token Vault.

Show child attributes

web_origins · string[]

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 web message.