Comment configurer les métadonnées d’application (client)

Les métadonnées du client constituent un champ facultatif stocké dans les propriétés de l’application (client). Elles se composent de clés et de valeurs personnalisables que vous pouvez définir pour chaque application. 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).

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 Rule 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 les app_metadata du profil utilisateur.

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.

Configurer les métadonnées de l’application

Vous pouvez définir les métadonnées de l’application à l’aide d’Auth0 Dashboard ou de .

Auth0 Dashboard
Management API

Accédez à Dashboard > Applications > Applications et sélectionnez l’application.
Dans l’onglet Settings (Paramètres), faites défiler la page jusqu’en bas et sélectionnez Advanced Settings (Paramètres avancés) pour développer la section.
Dans l’onglet Application Metadata (Métadonnées de l’application), vous pouvez :
- Ajouter des métadonnées en saisissant une clé et une valeur, puis en sélectionnant + Add (Ajouter).
- Mettre à jour des métadonnées en saisissant la clé à modifier et sa nouvelle valeur, puis en sélectionnant + Add (Ajouter).
- Supprimer des métadonnées en sélectionnant l’icône de corbeille à côté de la paire clé/valeur.
Une fois terminé, sélectionnez Save Changes (Enregistrer les modifications).

Lorsque vous créez une application avec le terminal d’applications POST /api/v2/, vous pouvez inclure un objet clientMetadata pour définir ses métadonnées initiales.Pour définir les métadonnées du client d’une application existante, utilisez le terminal PATCH /api/v2/clients/{id} en fournissant un objet d’application doté de la clientMetadata property, dont la valeur est un objet contenant les métadonnées que vous souhaitez modifier.Par exemple, si vous appelez PATCH /api/v2/client/myclientid123 avec le corps suivant :

{ "client_metadata": { "example_key": "example_value" } }

Vous obtenez les métadonnées suivantes :

Example metadata

{
  "name": "example_client",
  "client_metadata": {
    "example_key": "example_value"
  }
  ...
}

Vous pouvez mettre à jour des valeurs de métadonnées existantes avec un appel PATCH semblable, en fournissant la nouvelle valeur de la clé. Pour reprendre l’exemple précédent, si votre appel PATCH utilise le corps suivant :

{ "client_metadata": { "example_key": "updated_value" } }

Vous obtenez les métadonnées suivantes :

Updated metadata

{
  "name": "example_client",
  "client_metadata": {
    "example_key": "updated_value"
  }
  ...
}

Vous pouvez supprimer des métadonnées du client avec un appel PATCH semblable, en indiquant null comme valeur de la clé.

Afficher les métadonnées d’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 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
}

Les métadonnées du client figurent également dans les réponses des terminaux GET /api/v2/clients et GET /api/v2/client/{id} de la Management API.

Limites

Le champ client_metadata peut contenir au maximum 10 clés.
Les clés et les valeurs de client_metadata ne peuvent pas dépasser 255 caractères chacune.
Les clés et les valeurs de client_metadata ne peuvent pas contenir de caractères spéciaux UTF-8.

Guides de démarrage rapide

Présentation d’Auth0

Configurer Auth0

Applications

Comment configurer les métadonnées d’application (client)

Où stocker les secrets du client

Configurer les métadonnées de l’application

Afficher les métadonnées d’application

Limites

​Où stocker les secrets du client

​Configurer les métadonnées de l’application

​Afficher les métadonnées d’application

​Limites

Où stocker les secrets du client

Configurer les métadonnées de l’application

Afficher les métadonnées d’application

Limites