PublishableApiKey

A Publishable API key defines scopes that resources are available in. Then, it can be used in request to infer the resources without having to directly pass them. For example, a publishable API key can be associated with one or more sales channels. Then, when the publishable API key is passed in the header of a request, it is inferred what sales channel is being used without having to pass the sales channel as a query or body parameter of the request. Publishable API keys can only be used with sales channels, at the moment.

Properties

idstringRequired

The key's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

created_bynull | stringRequired

The unique identifier of the user that created the key.

revoked_bynull | stringRequired

The unique identifier of the user that revoked the key.

titlestringRequired

The key's title.

revoked_atDate

The date with timezone at which the key was revoked.