Delegated Administration: Extension Hooks

Delegated Admin - Administrator role が割り当てられているユーザーは、Delegated Administration extension の動作をカスタマイズするための各種 Extension Hooks とクエリを管理できます。設定エリアにアクセスするには、次の手順に従います。

Delegated Administration Dashboard にログインします。
右上にある自分の名前をクリックします。ドロップダウンメニューが表示されるので、Configure オプションをクリックします。

リダイレクト先の Configuration ページで、Hooks とクエリを管理できます。

Extension Hooks のコンテキスト

コンテキスト (ctx) オブジェクトには、現在のリクエストに関するいくつかのヘルパーと情報が含まれています。以下のメソッドとプロパティは、すべての Extension Hook で利用できます。

ログ
キャッシュ
Custom Data
ペイロードとリクエスト
リモート呼び出し

ログ

Actions リアルタイムログ (Actions リアルタイムログで表示できます) にメッセージを追加するには、log メソッドを呼び出します：

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

キャッシュ

何か (たとえば部署の長い一覧) をキャッシュするには、コンテキストの global オブジェクトに保存できます。このオブジェクトは、Actions リアルタイムログのコンテナが再作成されるまで利用できます。

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

カスタムデータ

extension 内にカスタムデータを保存できます。このフィールドに保存できるデータは 400 KB までです。

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

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

データを読むには:

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

ペイロードとリクエスト

各 Extension Hook では、現在のペイロードまたはリクエストに含まれる特定の情報を参照できます。リクエストには常に、Users Dashboard にログインしているユーザーに関する情報が含まれます。

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

リモート呼び出し

データを検証したりメンバーシップを読み込んだりするために、外部サービス (API など) を呼び出したい場合は、request モジュールを使用できます。

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

        // ...
    });
}

Hook の仕様

ctx: コンテキストオブジェクト
- payload: ペイロードオブジェクト
  - action: 現在実行中のアクション (例: delete:user)
  - user: アクションの実行対象となるユーザー
callback(error): アクセスが拒否された場合にエラーを返せるコールバック

使用例

ケリーは財務部門を管理しており、自分の部門内のユーザーのみにアクセスできるようにする必要があります。

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

  // 現在のユーザーのメタデータから部署を取得する。
  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.'));
  }

  // IT部門はすべてのユーザーにアクセスできる。
  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();
}

このフックが設定されていない場合、すべてのユーザーにアクセスできるようになります。サポートされているアクション名:

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

利用可能な Extension Hook

Delegated Administration アプリケーションでは、次の Extension Hook を使用できます。

ブランドのカスタマイズ

コードのカスタマイズ

サードパーティーのカスタマイズ

Delegated Administration: Extension Hooks

Extension Hooks のコンテキスト

ログ

キャッシュ

カスタムデータ

ペイロードとリクエスト

リモート呼び出し

Hook の仕様

使用例

利用可能な Extension Hook

詳しくはこちら

​Extension Hooks のコンテキスト

​ログ

​キャッシュ

​カスタムデータ

​ペイロード とリクエスト

​リモート呼び出し

​Hook の仕様

​使用例

​利用可能な Extension Hook

​詳しくはこちら

Extension Hooks のコンテキスト

ログ

キャッシュ

カスタムデータ

ペイロードとリクエスト

リモート呼び出し

Hook の仕様

使用例

利用可能な Extension Hook

詳しくはこちら