WHAT YOU'LL LEARN
  • What use cases are available in webiny/api/security/api-key?
  • How to use the builder and factory APIs?
  • How to import and use each exported item?

Overview
anchor

This page documents everything exported from webiny/api/security/api-key. Import any of the items below directly from this path in your Webiny extensions.

Use Cases
anchor

CreateApiKeyUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface CreateApiKeyUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

DeleteApiKeyUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface DeleteApiKeyUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetApiKeyByTokenUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface GetApiKeyByTokenUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

GetApiKeyUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface GetApiKeyUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

ListApiKeysUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface ListApiKeysUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

UpdateApiKeyUseCase
anchor

Use Case Abstraction — imported from webiny/api/security/api-key

Interface UpdateApiKeyUseCase.Interface:

Types:

Usage:

extensions/MyImpl.ts

Event Handlers
anchor

ApiKeyAfterCreateHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyAfterCreateHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyAfterDeleteHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyAfterDeleteHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyAfterUpdateHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyAfterUpdateHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeCreateHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyBeforeCreateHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeDeleteHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyBeforeDeleteHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeUpdateHandler
anchor

Event Handler Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyBeforeUpdateHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

Services
anchor

ApiKeyFactory
anchor

Abstraction — imported from webiny/api/security/api-key

Interface ApiKeyFactory.Interface:

Types:

Usage:

extensions/MyImpl.ts