Webhooks イベント
このガイドでは、Logto のさまざまな Webhook イベントと、それぞれのイベントが発生するタイミングについて説明します。
ユーザー操作 Webhook イベント
| イベントタイプ | 説明 |
|---|---|
| PostRegister | ユーザーが UI インターフェースを通じて新しいアカウントを正常に作成したときに発生します。 |
| PostSignIn | ユーザーが UI インターフェースを通じて正常にサインインしたときに発生します。 |
| PostResetPassword | 「パスワードを忘れた」フローでユーザーのパスワードが正常にリセットされたときに発生します。 |
データ変更 Webhook イベント
ユーザー
| イベントタイプ | 説明 |
|---|---|
| User.Created | 新しいユーザーアカウントが作成されました。 |
| User.Deleted | ユーザーアカウントが削除されました。 |
| User.Data.Updated | ユーザープロファイルデータが更新されました(例:メール、アバター、custom.data、ソーシャルIDなど)。 |
| User.SuspensionStatus.Updated | ユーザーの停止状態が変更されました(停止または再有効化)。 |
ロール (Role)
| イベントタイプ | 説明 |
|---|---|
| Role.Created | 新しいロールが作成されました。 |
| Role.Deleted | ロールが削除されました。 |
| Role.Data.Updated | ロールのデータが更新されました(例:ロール名、説明、デフォルトロール状態)。 |
| Role.Scopes.Updated | ロールに割り当てられた権限が追加または削除されました。 |
権限 (スコープ)
| イベントタイプ | 説明 |
|---|---|
| Scope.Created | 新しい API 権限が作成されました。 |
| Scope.Deleted | API 権限が削除されました。 |
| Scope.Data.Updated | API 権限のデータが更新されました(例:権限の説明)。 |
組織 (Organization)
| イベントタイプ | 説明 |
|---|---|
| Organization.Created | 新しい組織が作成されました。 |
| Organization.Deleted | 組織が削除されました。 |
| Organization.Data.Updated | 組織のデータが更新されました(例:組織名、説明、custom.data など)。 |
| Organization.Membership.Updated | ユーザーまたはアプリケーションが組織に追加または削除されました。ペイロードには メンバーシップ差分フィールド が含まれます。 |
組織ロール (Organization role)
| イベントタイプ | 説明 |
|---|---|
| OrganizationRole.Created | 新しい組織ロールが作成されました。 |
| OrganizationRole.Deleted | 組織ロールが削除されました。 |
| OrganizationRole.Data.Updated | 組織ロールのデータが更新されました(例:組織ロール名、説明)。 |
| OrganizationRole.Scopes.Updated | 組織ロールに割り当てられた権限が追加または削除されました。 |
組織権限 (スコープ)
| イベントタイプ | 説明 |
|---|---|
| OrganizationScope.Created | 新しい組織権限が作成されました。 |
| OrganizationScope.Deleted | 組織権限が削除されました。 |
| OrganizationScope.Data.Updated | 組織権限のデータが更新されました(例:組織権限の説明)。 |
Management API トリガーイベント
| API エンドポイント | イベント |
|---|---|
| POST /users | User.Created |
| DELETE /users/:userId | User.Deleted |
| PATCH /users/:userId | User.Data.Updated |
| PATCH /users/:userId/custom-data | User.Data.Updated |
| PATCH /users/:userId/profile | User.Data.Updated |
| PATCH /users/:userId/password | User.Data.Updated |
| PATCH /users/:userId/is-suspended | User.SuspensionStatus.Updated |
| POST /roles | Role.Created, (Role.Scopes.Update) |
| DELETE /roles/:id | Role.Deleted |
| PATCH /roles/:id | Role.Data.Updated |
| POST /roles/:id/scopes | Role.Scopes.Updated |
| DELETE /roles/:id/scopes/:scopeId | Role.Scopes.Updated |
| POST /resources/:resourceId/scopes | Scope.Created |
| DELETE /resources/:resourceId/scopes/:scopeId | Scope.Deleted |
| PATCH /resources/:resourceId/scopes/:scopeId | Scope.Data.Updated |
| POST /organizations | Organization.Created |
| DELETE /organizations/:id | Organization.Deleted |
| PATCH /organizations/:id | Organization.Data.Updated |
| PUT /organizations/:id/users | Organization.Membership.Updated |
| POST /organizations/:id/users | Organization.Membership.Updated |
| DELETE /organizations/:id/users/:userId | Organization.Membership.Updated |
| PUT /organizations/:id/applications | Organization.Membership.Updated |
| POST /organizations/:id/applications | Organization.Membership.Updated |
| DELETE /organizations/:id/applications/:applicationId | Organization.Membership.Updated |
| PUT /organization-invitations/:id/status (Accepted) | Organization.Membership.Updated |
| POST /organization-roles | OrganizationRole.Created, (OrganizationRole.Scopes.Updated) |
| DELETE /organization-roles/:id | OrganizationRole.Deleted |
| PATCH /organization-roles/:id | OrganizationRole.Data.Updated |
| POST /organization-scopes | OrganizationScope.Created |
| DELETE /organization-scopes/:id | OrganizationScope.Deleted |
| PATCH /organization-scopes/:id | OrganizationScope.Data.Updated |
| PUT /organization-roles/:id/scopes | OrganizationRole.Scopes.Updated |
| POST /organization-roles/:id/scopes | OrganizationRole.Scopes.Updated |
| DELETE /organization-roles/:id/scopes/:organizationScopeId | OrganizationRole.Scopes.Updated |
Experience API トリガーイベント
| ユーザー操作アクション | イベント |
|---|---|
| ユーザーのメール / 電話番号のリンク | User.Data.Updated |
| ユーザーの MFA のリンク | User.Data.Updated |
| ユーザーのソーシャル / SSO のリンク | User.Data.Updated |
| ユーザーのパスワードリセット | User.Data.Updated |
| ユーザー登録 | User.Created |
| ジャストインタイムプロビジョニング(メールドメインまたはエンタープライズ SSO コネクターの一致)で組織に自動プロビジョニング | Organization.Membership.Updated |
例外 Webhook イベント
セキュリティ
| イベントタイプ | 説明 |
|---|---|
| Identifier.Lockout | 連続したアイデンティティ確認失敗によりユーザーアカウントがロックされました。次のフローでトリガーされます:
|
| Message.RateLimited | エンドユーザーが認証コードの 送信レート制限 を超えました。エンドユーザー送信パス(Experience API および Account API)でのみ発生し、ペイロードは { action, recipient } です。 |
| Grant.LimitExceeded | 認可 (Authorization) が成功し、ユーザーがアプリの 最大同時認証デバイス数 制限 (maxAllowedGrants) を超えた場合、Logto はそのアプリの最も古いグラントを取り消します。 |
よくある質問
PostRegister と User.Created の違いは何ですか?
PostRegister と User.Created の違いは何ですか?PostRegister は、ユーザーがサインアップフローを通じて新しいアカウントを正常に作成したときにトリガーされます。User.Created は、Management API を通じて新しいユーザーアカウントが作成されたときにトリガーされます。