WHAT YOU'LL LEARN
  • What use cases are available in webiny/api/security/api-key?
  • Which event handlers can you implement?
  • 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

Event Handlers

Services

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

ApiKeyAfterCreateEventHandler
anchor

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

Interface ApiKeyAfterCreateEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyAfterDeleteEventHandler
anchor

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

Interface ApiKeyAfterDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyAfterUpdateEventHandler
anchor

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

Interface ApiKeyAfterUpdateEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeCreateEventHandler
anchor

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

Interface ApiKeyBeforeCreateEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeDeleteEventHandler
anchor

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

Interface ApiKeyBeforeDeleteEventHandler.Interface:

Types:

Usage:

extensions/MyHandler.ts

ApiKeyBeforeUpdateEventHandler
anchor

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

Interface ApiKeyBeforeUpdateEventHandler.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