API, Security & Auth

Authentication, API keys, roles, users, teams event handlers and use cases.

How to Use

1. Find the abstraction you need below
2. You MUST read the source file to get the exact interface and types!
3. Import: import { Name } from "<importPath>";
4. See webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns

Abstractions

---

Name: AfterAuthenticationEventHandler Import: import { AfterAuthenticationEventHandler } from "webiny/api/security/authentication" Source: @webiny/api-core/features/security/authentication/AuthenticationContext/index.ts Description: Hook into authentication lifecycle after authentication occurs.

---

Name: ApiKeyAfterCreateEventHandler Import: import { ApiKeyAfterCreateEventHandler } from "webiny/api/security/api-key" Source: @webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts Description: Hook into API key lifecycle after an API key is created.

---

Name: ApiKeyAfterDeleteEventHandler Import: import { ApiKeyAfterDeleteEventHandler } from "webiny/api/security/api-key" Source: @webiny/api-core/features/security/apiKeys/DeleteApiKey/index.ts Description: Hook into API key lifecycle after an API key is deleted.

---

Name: ApiKeyAfterUpdateEventHandler Import: import { ApiKeyAfterUpdateEventHandler } from "webiny/api/security/api-key" Source: @webiny/api-core/features/security/apiKeys/UpdateApiKey/index.ts Description: Hook into API key lifecycle after an API key is updated.

---

Name: ApiKeyBeforeCreateEventHandler Import: import { ApiKeyBeforeCreateEventHandler } from "webiny/api/security/api-key" Source: @webiny/api-core/features/security/apiKeys/CreateApiKey/index.ts Description: Hook into API key lifecycle before an API key is created.

---