skills.rest
webiny
webinyOFFICIAL
Explore all skills by this author →
Website𝕏@WebinyCMSGitHub

webiny-api-security-catalog

Catalogs Webiny API security abstractions for authentication, API keys, roles, users, and teams.

8.0k|673|Updated Jan 9, 2018
Search Tags:#roles#Security#Authentication#event handlers#API keys#webiny#identity provider
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-api-security-catalog
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webiny-api-security-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/api/security
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-api-security-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny's security layer often struggle to locate the correct abstraction, import path, and source file among dozens of authentication, authorization, API key, role, user, and team primitives scattered across the codebase.

Core Features & Use Cases

  • Abstraction Catalog: Lists 53 security abstractions with exact import paths, source file locations, and descriptions covering authentication, authorization, API keys, roles, users, and teams.
  • Lifecycle Event Handlers: Documents before/after event handlers for API key, role, and user lifecycles so developers can hook into security workflows.
  • Use Case: When building a custom identity provider or adding a hook that runs after a user is created, look up UserAfterCreateEventHandler or IdentityProvider here, read the referenced source file, and import it from the documented path.

Quick Start

Ask the AI to find the Webiny security abstraction for creating API keys and show its import path and source file.

Frequently Asked Questions about webiny-api-security-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create an API key programmatically in Webiny?▼

Use the CreateApiKeyUseCase abstraction imported from webiny/api/security/api-key. Its source is in @webiny/api-core/features/security/apiKeys/CreateApiKey, and you can hook into the lifecycle with ApiKeyBeforeCreateEventHandler or ApiKeyAfterCreateEventHandler.

How do I hook into Webiny user lifecycle events?▼

Webiny provides before and after event handlers for user create, update, and delete operations, such as UserAfterCreateEventHandler imported from webiny/api/security/user. Implement the handler interface and register it to run custom logic around user operations.

What identity providers does Webiny API support?▼

Webiny provides IdentityProvider, JwtIdentityProvider, and OidcIdentityProvider abstractions from webiny/api/security. JWT handles token validation while the OIDC provider adds issuer validation for OpenID Connect compliant identity systems.

How do I define security roles in code with Webiny?▼

Use the RoleFactory abstraction imported from webiny/api/security to provide code-defined security roles with permissions. For runtime role management, use CreateRoleUseCase, UpdateRoleUseCase, and DeleteRoleUseCase from webiny/api/security/role.

Does Webiny support custom authentication logic?▼

Yes, implement the Authenticator abstraction to convert an authentication token into identity data, and use BeforeAuthenticationEventHandler or AfterAuthenticationEventHandler to hook into the authentication lifecycle. IdentityContext then exposes the current identity and permissions.

Related Skills

Explore More Software Engineering Skills→
fycd2006fycd2006

admin-developer

Build and wire admin features with React views, DI, and MobX.

Community
Advanced
webinywebiny
8.0k

backend-developer

Implement backend API features using Webiny architecture and GraphQL schemas.

Official
Advanced
kraftvaerkkraftvaerk

umbraco-granular-user-permissions

Implement granular user permissions for specific entity types in the Umbraco backoffice.

Official
Intermediate
vudovnvudovn
8.2k

simplify-code

Reduces code complexity by removing dead code, flattening nesting, and eliminating unnecessary abstractions.

Community
Intermediate