@@ -43,8 +43,18 @@ type UserEntity = {
4343```
4444
4545``` tsx
46+ enum ApplicationType {
47+ Native = ' Native' ,
48+ SPA = ' SPA' ,
49+ Traditional = ' Traditional' ,
50+ MachineToMachine = ' MachineToMachine' ,
51+ Protected = ' Protected' ,
52+ SAML = ' SAML' ,
53+ }
54+
4655type ApplicationEntity = {
4756 id: string ;
57+ type: ApplicationType ;
4858 name: string ;
4959 description? : string ;
5060};
@@ -203,3 +213,31 @@ type OrganizationScope = {
203213| OrganizationScope.Created | data | OrganizationScope | | The created organization scope entity. |
204214| OrganizationScope.Data.Updated | data | OrganizationScope | | The updated organization scope entity. |
205215| OrganizationScope.Deleted | data | null | / | |
216+
217+ ## Exception hook events request body
218+
219+ Available events: ` Identifier.Lockout `
220+
221+ The request body is a JSON object that contains the standard request body fields and additional fields as below:
222+
223+ ``` tsx
224+ enum SignInIdentifier {
225+ Email = ' email' ,
226+ Phone = ' phone' ,
227+ Username = ' username' ,
228+ }
229+ ```
230+
231+ | Field | Type | Optional | Notes |
232+ | ---------------- | ------------------- | -------- | ------------------------------------------------------------------ |
233+ | hookId | ` string ` | | The identifier in Logto. |
234+ | event | ` string ` | | Which event that triggers this hook. |
235+ | createdAt | ` string ` | | The create time of payload in ISO format. |
236+ | userAgent | ` string ` | ✅ | The user-agent for the request. |
237+ | ip | ` string ` | ✅ | The IP address for the request. |
238+ | interactionEvent | ` string ` | ✅ | The interaction event that triggers this hook. |
239+ | sessionId | ` string ` | ✅ | The Session ID (not Interaction ID) for this event, if applicable. |
240+ | applicationId | ` string ` | ✅ | The related Application ID for this event, if applicable. |
241+ | application | ` ApplicationEntity ` | ✅ | The related application info for this event, if applicable. |
242+ | type | ` SignInIdentifier ` | | The user's identifier type, e.g., email, phone or username. |
243+ | value | ` string ` | | The user's identifier value that triggered the lockout. |
0 commit comments