Delegated Administration : Filter Hook

Découvrez comment utiliser le Filter Hook avec la Delegated Administration Extension.

Par défaut, les utilisateurs ayant le rôle Delegated Admin - User voient tous les utilisateurs associés au compte Auth0. Cependant, vous pouvez filtrer les données auxquelles ils ont accès à l’aide du Filter Hook.

​

Contrat du Hook

• ctx : Objet de contexte.
• callback(error, query) : Fonction de rappel dans laquelle vous pouvez renvoyer une erreur ou la requête Lucene utilisée pour filtrer les utilisateurs. L’extension enverra cette requête au point de terminaison Get Users de la Management API.

Pour en savoir plus sur la requête Lucene, consultez User Search Query Syntax.

​

Exemple d’utilisation

Si Kelly gère le département Finance, elle ne devrait voir que les utilisateurs qui font aussi partie du département Finance. Nous filtrerons les utilisateurs en fonction du département de l’utilisateur actuel (soit, dans ce cas-ci, le département Finance pour le département et Kelly pour l’utilisateur, respectivement).

function(ctx, callback) {
  // Récupérer le département à partir des métadonnées de l'utilisateur actuel.
  var department = ctx.request.user.app_metadata && ctx.request.user.app_metadata.department;
  if (!department || !department.length) {
    return callback(new Error('The current user is not part of any department.'));
  }

  // Le département TI peut voir tous les utilisateurs.
  if (department === 'IT') {
    return callback();
  }

  // Retourner la requête Lucene.
  return callback(null, 'app_metadata.department:"' + department + '"');
}

​

Remplacement du search engine

Vous pouvez remplacer le search engine par défaut en indiquant votre choix dans la réponse.

// Retourner la requête lucene.
return callback(null, { query: 'app_metadata.department:"' + department + '"', searchEngine: 'v2' });

​

Remarques

N’utilisez pas de guillemets simples, de guillemets doubles ni d’autres caractères spéciaux (comme + ou -) dans les termes sur lesquels vous souhaitez appliquer un filtre. Cela peut entraîner des problèmes avec la requête Lucene.

Si vous utilisez plusieurs opérateurs comme OR, NOT ou AND, placez ces paramètres de recherche entre parenthèses [()] afin de préciser où chaque opérateur s’applique.

Si vous ne configurez pas ce Hook, la recherche renvoie tous les utilisateurs.

​

En savoir plus

• Delegated Administration: Access Hook
• Delegated Administration: Memberships Query Hook
• Delegated Administration: Settings Query Hook
• Delegated Administration: Write Hook