Configurer les métadonnées de l’application

Découvrez comment configurer, mettre à jour et supprimer les métadonnées de l’application (client_metadata et clientMetadata) dans Applications > Paramètres avancés du Dashboard Auth0.

Les métadonnées de l’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 de client_metadata, et dans les Rules sous la forme de 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 client

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

• S’il n’y a qu’un seul secret par application, client_metadata est un bon choix.
• S’il s’agit du même secret pour l’ensemble du système (c.-à-d. pour toutes les applications ou pour plusieurs d’entre elles), les valeurs de configuration de la rule peuvent être un meilleur choix
• S’il s’agit d’un secret différent pour chaque utilisateur, 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 flow que vous utilisez, l’utilisateur pourrait donc être en mesure d’obtenir le token et d’en examiner le contenu. Auth0 ne recommande pas d’y stocker un secret.

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

Vous pouvez accéder aux métadonnées de l’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 y ajouter des paires clé-valeur à 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 et cliquez sur paramètres avancés.

3. Dans l’onglet Application Metadata, entrez le nom et la valeur de la clé, 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, puis cliquez sur paramètres avancés.
3. Dans l’onglet Application Metadata, saisissez le nom de la clé que vous souhaitez modifier, puis entrez une nouvelle valeur et cliquez sur Add.
4. Cliquez sur Save Changes

​

Supprimer les 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 paramètres avancés.
3. Dans l’onglet Application Metadata, repérez la paire clé-valeur que vous voulez supprimer, puis cliquez sur l’icône de corbeille.
4. Confirmez la suppression.
5. Cliquez sur Save Changes.

​

Pour 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 les Rules
• Faire la rotation des secrets client