Configurer les métadonnées d’application

Découvrez comment configurer, mettre à jour et supprimer les métadonnées d’application (client_metadata et clientMetadata) dans les Advanced Settings de la section Applications de l’Auth0 Dashboard.

Les métadonnées d’application sont facultatives et se composent de clés et de valeurs personnalisables (255 caractères max chacune) que vous pouvez définir pour chaque application. Les métadonnées sont exposées dans l’objet Client sous la forme client_metadata, et dans Rules sous la forme context.clientMetadata. Vous pouvez, par exemple, y stocker l’URL de la page d’accueil de l’application (un champ qu’Auth0 ne fournit pas par défaut dans les paramètres de l’application).

Les métadonnées du client sont stockées dans les propriétés de l’application (client). Pour en savoir plus sur les types de données, les noms de champs et les limites de stockage, consultez Noms de champs et types de données des métadonnées.

Où stocker les secrets du client

L’endroit où stocker le secret dépend de sa portée :

• S’agit-il d’un seul secret par application ? Alors client_metadata est un bon endroit.
• S’agit-il du même secret pour tout le système (c.-à-d. pour toutes les applications ou pour plusieurs d’entre elles) ? Alors les valeurs de configuration de la règle pourraient être un meilleur choix
• S’agit-il d’un secret différent pour chaque utilisateur ? Alors il peut être préférable de le stocker dans app_metadata.

Les claims dans le ID token ne sont pas chiffrés. Selon le flux que vous utilisez, l’utilisateur pourrait donc être en mesure d’obtenir le token et d’en inspecter le contenu. Auth0 ne recommande pas de stocker un secret de cette façon.

Les applications existantes n’auront aucune valeur pour cette propriété.

Vous pouvez accéder aux métadonnées d’application dans Actions:

exports.onExecutePostLogin = async (event, api) => {
  if (event.client.metadata.SKIP_VERIFICATION === "yes"){
    return;
  }
  // ... continuer cette Action
}

… ou dans Rules :

function applicationMetadataExample (user, context, callback){
  context.clientMetadata = context.clientMetadata || {};
  if (context.clientMetadata.SKIP_VERIFICATION === "yes"){
    return callback();
  }
  // ... continuer cette règle
}

Vous pouvez consulter les métadonnées de l’application et en ajouter à l’aide du Dashboard ou de la Management API. Pour savoir comment gérer les métadonnées du client avec la Management API, consultez gérer les métadonnées à l’aide de la Management API.

​

Ajouter des paires clé-valeur aux métadonnées de l’application

1. Accédez à Dashboard > Applications > Applications et sélectionnez l’application.

2. Faites défiler la page vers le bas, puis cliquez sur Advanced Settings.

3. Dans l’onglet Application Metadata, entrez le nom de la clé et sa valeur, puis cliquez sur Add.

   

4. Cliquez sur Save Changes.

​

Mettre à jour la valeur des métadonnées de l’application

1. Accédez à Dashboard > Applications > Applications et sélectionnez l’application.
2. Faites défiler la page vers le bas et cliquez sur Advanced Settings.
3. Dans l’onglet Application Metadata, saisissez le nom de la clé que vous souhaitez modifier et entrez une nouvelle valeur, puis cliquez sur Add.
4. Cliquez sur Save Changes

​

Supprimer les métadonnées de l’application

1. Allez à Dashboard > Applications > Applications et sélectionnez l’application.
2. Faites défiler la page vers le bas et cliquez sur Advanced Settings.
3. Dans l’onglet Application Metadata, repérez la paire clé-valeur que vous souhaitez supprimer et cliquez sur l’icône de la corbeille.
4. Confirmez la suppression.
5. Cliquez sur Save Changes.

​

En savoir plus

• Noms de champs et types de données des métadonnées
• Gérer les métadonnées à l’aide de la Management API
• Gérer les métadonnées avec Rules
• Rotation des secrets client