ApiKey - API Key Module Data Models Reference

This documentation provides a reference to the ApiKey data model. It belongs to the API Key Module.

idPrimaryKeyModifier<IdProperty>

The ID of the API key.

tokenTextProperty

The token of the API key

saltTextProperty

Salt used to create the API key token.

redactedTextProperty

The redacted form of the api key's token. this is useful when showing portion of the token.

titleTextProperty

The title of the API key

typeEnumProperty<["publishable", "secret"]>

The type of the API key. Can be secret or publishable.

created_byTextProperty

The ID of the user that created the API key

last_used_atDateTimePropertyOptional

The date the API key was last used.

revoked_byTextPropertyOptional

The ID of the user that revoked the API key

revoked_atDateTimePropertyOptional

The date the API key was revoked.

Was this page helpful?