メインコンテンツまでスキップ
バージョン: 0.14.0 (最新)

🆔 アイデンティティ

アイデンティティは services.identitiesService を通じて、管理者専用のアイデンティティレコードのリスト取得、取得、更新、削除、ロック、解除用のHTTPエンドポイントを提供します。

ここから始める​

services.identitiesService をAPIプレフィックスの下にマウントします。サービスの defService ルーターは自身で express.json() をインストールします；Cookieモードの場合、ホストはサービスルーターの前に cookie-parser を登録することも必要です。全ての6つのルートには有効な管理者アクセストークンが必要なので、identities コレクション、認証シークレット、および設定されたアイデンティティ型IDを提供します。

import express from 'express';
import cookieParser from 'cookie-parser';
import { services } from '@nodeblocks/backend-sdk';

const app = express();
app.use(cookieParser()); // authMode が 'cookie' の場合にのみ必要。
app.use(
  '/api',
  services.identitiesService(
    { identities },
    {
      authSecrets: {
        authEncSecret: process.env.AUTH_ENC_SECRET!,
        authSignSecret: process.env.AUTH_SIGN_SECRET!,
      },
      authMode: 'bearer',
      identity: {
        typeIds: {
          admin: 'administrator-type-id',
          guest: 'guest-type-id',
          regular: 'regular-type-id',
        },
      },
    },
  ),
);
設定デフォルト/ソースの動作効果
dataStores.identities必須アイデンティティブロックと checkIdentityType(['admin']) によって使用される。
authSecrets.authEncSecret、authSecrets.authSignSecret必須選択されたトークン認証アダプタによって使用される。
authMode省略または 'bearer' は Authorization ヘッダーアダプタを使用；'cookie' は request.cookies.accessToken を使用保護されたルートのアクセストークンのトランスポートを選択する。
identity.typeIds.adminランタイム時に必須checkIdentityType(['admin']) は呼び出し元の読み込まれた typeId とこの値を比較する。
identity.typeIds.guest、identity.typeIds.regular提供された場合、宣言された typeIds オブジェクトによって必須これらのアイデンティティルートでは使用されない。

全てのルートは最初に isAuthenticated() を実行し、次に checkIdentityType(['admin']) を実行します。2番目のバリデーターは呼び出し元のアイデンティティの読み込みと認可をしながら再度認証を行います；アイデンティティバリデーター を参照してください。

よくあるタスク​

タスク該当ドキュメントコントラクト
アイデンティティのリストまたはフィルタリングfindIdentitiesFeaturefindIdentitiesFeature、findIdentitySchema、および findIdentitiesRoute
1つのアイデンティティの取得または更新getIdentityRoutegetIdentityRoute、updateIdentitySchema、および updateIdentityRoute
アイデンティティのロック、解除、または削除lockIdentityRoutelockIdentityRoute、unlockIdentityRoute、および deleteIdentityRoute
アイデンティティデータベースヘルパーを再利用するアイデンティティブロックアイデンティティブロック

Bearer HTTPワークフロー​

authMode を省略または 'bearer' に設定する場合、Authorization ヘッダーに管理者アクセストークンを送信します。

ACCESS_TOKEN='管理者のアクセストークンに置き換えてください'
curl "https://api.example.test/api/identities?name=Example&page=1&limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

成功時、findIdentitiesRoute はデフォルトの 200 JSON配列を返します（password と MongoDB _id を削除）。非管理者呼び出し元は 403 で拒否されます；トークン設定の欠落または無効なトークンも共有バリデーターコントラクト 経由で失敗します。

authMode: 'cookie' の場合、サービスルーターの前に cookie-parser を登録し、accessToken Cookieを送信します。

IDENTITY_ID='identity-demo-001'
ACCESS_TOKEN='管理者のアクセストークンに置き換えてください'
curl -i -X POST "https://api.example.test/api/identities/$IDENTITY_ID/lock" \
  -H "Cookie: accessToken=$ACCESS_TOKEN"

成功時、lockIdentityRoute はボディなしの 204 を返します。accessToken Cookie の欠落は 401 を生成します；認証には依然として設定された管理者アイデンティティ型が必要です。

カスタム機能合成​

このフラグメントは意図的にアイデンティティ取得とロックのみをマウントします。同じアイデンティティデータストア、認証アダプタ、および設定コンテキストを供給する必要があります。

import { partial } from 'ramda';
import { features, primitives, utils } from '@nodeblocks/backend-sdk';

const identityFeatureComposer = primitives.compose(
  features.getIdentityFeature,
  features.lockIdentityFeature,
);
const identityRouter = primitives.defService(
  partial(identityFeatureComposer, [{
    authenticate: utils.getBearerTokenInfo,
    configuration: {
      authSecrets,
      identity: { typeIds },
    },
    dataStores: { identities },
  }]),
);

app.use('/api', identityRouter);

リファレンスマップ​

ページ目的
ブロックアイデンティティデータベース操作、状態ペイロードビルダー、および削除ターミネーター
機能サービスによってマウントされるスキーマからルートへのコンポーザー
ルートエンドポイントメソッド、パス、アクセスルール、ステータス、およびパイプライン
スキーマリクエストコントラクトと共有の identityId パラメーター
バリデーター全てのアイデンティティルートによって使用される共有認証と管理者チェック

アイデンティティには handlers.md がありません；ルーターは再利用可能なブロックを直接合成します。

関連モジュール​

認証 はアイデンティティルートによって使用されるアクセストークンのフローと正規化子を供給します。共有バリデーター は isAuthenticated() と checkIdentityType(['admin']) を提供し；共有スキーマ は共有 pagination パラメーターを提供します。プロフィール はアイデンティティスコープのプロフィールルックアップのために findByIdentityIdSchema と buildIdentityIdFilter を消費します。