🛣️ Organization ルート
Organization ルートは Express ミドルウェアではなく SDK コンポーザーです。対応する 機能 または organizationService をマウントしてください。各詳細にはスキーマ、バリデーター、パイプライン、レスポンス契約へのリンクがあります。
一覧
詳細
createOrganizationRoute
実装
エンドポイント: POST /organizations
親/祖先およびロゴ正規化を伴って、POST /organizations で新しい Organization を作成します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → checkIdentityType.
リクエスト: createOrganizationSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → calculateChildAncestors → noop → createOrganization → normalizeLogoOfOwner → normalizeOrganizationTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
getOrganizationRoute
実装
エンドポイント: GET /organizations/:organizationId
ロゴ正規化とアクセス制御を伴って、GET /organizations/:organizationId で指定した Organization を取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: getOrganizationSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → normalizeCertificateImage → normalizeLogoOfOwner → normalizeOrganizationTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
findOrganizationsRoute
実装
エンドポイント: GET /organizations
管理者ユーザー向けに証明書とロゴを正規化し、GET /organizations でページネーション済み Organization リストを取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → checkIdentityType.
リクエスト: findOrganizationsSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: findOrganizations → normalizeCertificateImages → normalizeLogosOfOwners → applySpec → normalizeOrganizationsListTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
updateOrganizationRoute
実装
エンドポイント: PATCH /organizations/:organizationId
ロゴ正規化とアクセス制御を伴って、PATCH /organizations/:organizationId で既存の Organization を更新します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: updateOrganizationSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: updateOrganization → getOrganizationById → normalizeCertificateImage → normalizeLogoOfOwner → normalizeOrganizationTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
updateOrganizationAsAdminRoute
実装
エンドポイント: PATCH /admin/organizations/:organizationId/
PATCH /admin/organizations/:organizationId/ で管理者として Organization を更新します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → checkIdentityType.
リクエスト: updateOrganizationAsAdminSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: validateAuditStatus → updateOrganization → getOrganizationById → normalizeCertificateImage → normalizeLogoOfOwner → normalizeOrganizationTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
deleteOrganizationRoute
実装
エンドポイント: DELETE /organizations/:organizationId
DELETE /organizations/:organizationId で Organization とそのロゴを削除します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: deleteOrganizationSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → deleteLogoOfOwner → deleteOrganization → deleteOrganizationTerminator.
成功: 204; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
getOrganizationMemberRoleRoute
実装
エンドポイント: GET /organizations/:organizationId/members/:identityId/role
GET /organizations/:organizationId/members/:identityId/role で、Organization 内の指定メンバーのロールを取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: getOrganizationMemberRoleSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → buildOrganizationsForMemberByIdsQuery → findOrganizations → calculateMemberRole.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
checkOrganizationMemberExistenceRoute
実装
エンドポイント: GET /organizations/:organizationId/members/check-existence
GET /organizations/:organizationId/members/check-existence で、指定したアイデンティティが Organization のメンバーとして存在するか確認します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: checkOrganizationMemberExistenceSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → checkOrganizationMemberExistence → normalizeOrganizationMemberExistenceTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
findOrganizationMembersRoute
実装
エンドポイント: GET /organizations/:organizationId/members
GET /organizations/:organizationId/members で、Organization 内のすべてのメンバーを取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: findOrganizationMembersSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: findOrganizationMembers → normalizeOrganizationMembersListTerminator.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
upsertOrganizationMembersRoute
実装
エンドポイント: PATCH /organizations/:organizationId/members
PATCH /organizations/:organizationId/members で、Organization 内のメンバーをアップサートします。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → all → hasOrgRole → hasOrgRoleAssignmentPermission → hasOrgOwnerRemainingAfterMembersUpsert.
リクエスト: upsertOrganizationMembersSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → upsertOrganizationMembers → upsertOrganizationMembersTerminator.
成功: 204; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
deleteOrganizationMemberRoute
実装
エンドポイント: DELETE /organizations/:organizationId/members/:identityId
DELETE /organizations/:organizationId/members/:identityId で、Organization からメンバーを削除します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → all → hasOrgRole → hasOrgRoleSameOrAbove → hasOrgOwnerRemainingAfterMemberRemoval.
リクエスト: deleteOrganizationMemberSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: deleteOrganizationMember → deleteOrganizationMemberTerminator.
成功: 204; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
findOrganizationsForMemberRoute
実装
エンドポイント: GET /organizations/members/:identityId
GET /organizations/members/:identityId で、直接および継承ロールを含む指定メンバーのすべての Organization を取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → isSelf.
リクエスト: findOrganizationsForMemberSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: buildOrganizationsForMemberByRoleQuery → findOrganizations → normalizeCertificateImages → normalizeLogosOfOwners → buildOrganizationsWithDescendantsQuery → extractAncestors → buildOrganizationsForMemberByIdsQuery → calculateMemberRoleForOrganizations → normalizeOrganizationsForMember.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
findOrganizationDescendantsRoute
実装
エンドポイント: GET /organizations/:organizationId/descendants
ページネーションと正規化を備えた Organization 子孫取得ルートです。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: findOrganizationDescendantsSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → buildDescendantsQuery → findOrganizations → normalizeOrganizations → applySpec.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
getLogoUploadUrlRoute
実装
エンドポイント: GET /organizations/:organizationId/logo-upload-url
GET /organizations/:organizationId/logo-upload-url で、Organization ロゴ用の署名付きアップロード URL を生成します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: getSignedImageUploadUrlSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: generateFileUploadUrl.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
getCertificateUploadUrlRoute
実装
エンドポイント: GET /organizations/:organizationId/certificate-upload-url
GET /organizations/:organizationId/certificate-upload-url で、Organization 証明書用の署名付きアップロード URL を生成します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: getCertificateUploadUrlSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: generateFileUploadUrl.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
createChangeRequestRoute
実装
エンドポイント: POST /organizations/:organizationId/change-requests
POST /organizations/:organizationId/change-requests で Organization の変更リクエストを作成します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: createChangeRequestSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → validateOrganizationName → noop → extractTokenFromAuthorizationHeader → checkToken → createChangeRequest → buildUpdateOrganizationAfterNewChangeRequestPayload → updateOrganization → normalizeEmptyBody.
成功: 204; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
findChangeRequestsForOrganizationRoute
実装
エンドポイント: GET /organizations/:organizationId/change-requests
GET /organizations/:organizationId/change-requests で、指定した Organization の変更リクエストを取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: findChangeRequestsForOrganizationSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: findChangeRequests → normalizeChangeRequests → applySpec.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示
getOrganizationFollowersRoute
実装
エンドポイント: GET /organizations/:organizationId/followers
GET /organizations/:organizationId/followers で Organization のフォロワーを取得します。
アクセス: ソースは次のバリデーターチェーンを順に実行します: isAuthenticated → some → checkIdentityType → hasOrgRole.
リクエスト: getOrganizationFollowersSchema はパス、クエリ、ヘッダー、JSON 本文の契約を定義します。
パイプライン: getOrganizationById → buildOrganizationFollowersByFollowOrganizationIdQuery → buildWithoutMongoIdFindOptions → findProfiles → normalizeFollowers → applySpec.
成功: 200; 完全なソースには、最終的な通常値、ターミネーター、または orThrow のレスポンス記述子が示されています。
失敗: バリデーターの失敗はパイプラインより前に発生します。ソースで対応付けられたブロックエラーとステータス対応は、以下の完全な定義に保持されています。完全なソースを表示