Delegated Administration : Extension Hooks

Découvrez comment personnaliser le comportement de la Delegated Administration Extension à l’aide des Extension Hooks.

Si le rôle Delegated Admin - Administrator vous a été attribué, vous pouvez gérer les différents Extension Hooks et les requêtes qui vous permettent de personnaliser le comportement de la Delegated Administration Extension.

Pour accéder à la zone de configuration :

1. Connectez-vous au Delegated Administration Dashboard.
2. Cliquez sur votre nom dans le coin supérieur droit. Un menu déroulant s’affichera; cliquez sur l’option Configurer.

La page Configuration vers laquelle vous êtes redirigé vous permet de gérer vos Hooks et vos requêtes.

​

Contexte des Extension Hooks

L’objet context (ctx) expose quelques fonctions utilitaires ainsi que des renseignements sur la requête en cours. Les méthodes et propriétés suivantes sont disponibles dans chaque Extension Hook :

• Journalisation
• Mise en cache
• Données personnalisées
• Payload et requête
• Appels à distance

​

Journalisation

Pour ajouter un message aux journaux en temps réel d’Actions (que vous pouvez consulter dans Actions Real-time Logs), appelez la méthode log :

function(ctx, callback) {
  ctx.log('Logging action:', ctx.payload.action);
  return callback();
}

​

Mise en cache

Pour mettre quelque chose en cache (comme une longue liste de départements), vous pouvez le stocker dans l’objet global du contexte. Cet objet sera accessible jusqu’au recyclage du conteneur d’Actions Real-Time Logs.

function(ctx, callback) {
  ctx.global.departments = [ 'IT', 'HR', 'Finance' ];
  return callback();
}

​

Données personnalisées

Vous pouvez stocker des données personnalisées dans l’extension. Ce champ est limité à 400 ko de données.

var data = {
departments: [ 'IT', 'HR', 'Finance' ]
};

ctx.write(data)
.then(function() {
    // ...
})
.catch(function(err) {
    // ...
});

Pour lire les données :

ctx.read()
.then(function(data) {
    // ...
})
.catch(function(err) {
    // ...
});

​

Payload et requête

Chaque Extension Hook expose le payload ou la requête en cours avec des renseignements précis. La requête contiendra toujours des renseignements sur l’utilisateur connecté dans la section Users du Dashboard :

function(ctx, callback) {
  ctx.log('Current User:', ctx.request.user);
  return callback();
}

​

Appels à distance

Si vous voulez faire appel à un service externe (comme une API) pour valider des données ou charger des appartenances, vous pouvez le faire à l’aide du module request.

function(ctx, callback) {
var request = require('request');
    request('http://api.mycompany.com/departments', function (error, response, body) {
        if (error) {
        return callback(error);
        }

        // ...
    });
}

​

Contrat du Hook

• ctx : l’objet de contexte

  • payload : l’objet payload

    • action : l’action en cours d’exécution (par exemple, delete:user)
    • user : l’utilisateur sur lequel l’action est exécutée

• callback(error) : le callback auquel vous pouvez renvoyer une erreur si l’accès est refusé

​

Exemple d’utilisation

Kelly gère le département des finances, et elle ne devrait avoir accès qu’aux utilisateurs de son département.

function(ctx, callback) {
  if (ctx.payload.action === 'delete:user') {
    return callback(new Error('You are not allowed to delete users.'));
  }

  // Obtenir 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 accéder à tous les utilisateurs.
  if (department === 'IT') {
    return callback();
  }

  ctx.log('Verifying access:', ctx.payload.user.app_metadata.department, department);

  if (!ctx.payload.user.app_metadata.department || ctx.payload.user.app_metadata.department !== department) {
    return callback(new Error('You can only access users within your own department.'));
  }

  return callback();
}

Si ce hook n’est pas configuré, tous les utilisateurs auront accès.

Noms d’action pris en charge :

• read:user
• delete:user
• reset:password
• change:password
• change:username
• change:email
• read:devices
• read:logs
• remove:multifactor-provider
• block:user
• unblock:user
• send:verification-email

​

Hooks d’extension disponibles

Les Hooks d’extension suivants sont disponibles pour l’application Delegated Administration :

• Access Hook
• Custom Domain Hook
• Filter Hook
• Memberships Query Hook
• Settings Query Hook
• Write Hook

​

Pour en savoir plus

• Delegated Administration : Access Hook
• Delegated Administration : Custom Domain Hook
• Delegated Administration : Filter Hook
• Delegated Administration : Memberships Query Hook
• Delegated Administration : Settings Query Hook
• Delegated Administration : Write Hook