createApiKeysStep - Medusa Core Workflows Reference

This documentation provides a reference to the createApiKeysStep. It belongs to the @medusajs/medusa/core-flows package.

This step creates one or more API keys.

Example#

Code
1const data = createApiKeysStep({2  api_keys: [3    {4      type: "publishable",5      title: "Storefront",6      created_by: "user_123"7    }8  ]9})

Input#

CreateApiKeysStepInputCreateApiKeysStepInput

The data to create API keys.

api_keysCreateApiKeyDTO[]

The API keys to create.

Output#

ApiKeyDTO[]ApiKeyDTO[]

idstring

The ID of the API key.

tokenstring

The token of the API key.

redactedstring

The redacted form of the API key's token. This is useful when showing portion of the token. For example sk_...123.

titlestring

The title of the API key.

typeApiKeyType

The type of the API key.

last_used_atnull | Date

The date the API key was last used.

created_bystring

Who created the API key.

created_atDate

The date the API key was created.

updated_atDate

The date the API key was updated.

deleted_atnull | Date

The date the API key was deleted.

revoked_bynull | string

Who revoked the API key. For example, the ID of the user that revoked it.

revoked_atnull | Date

The date the API key was revoked.