Description

Topic: API Keys

Fields

created_at: String!

The date and time when the key was created, RFC3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

expires_at: String!

The date and time when the key expires, RFC3339 format

Example: "2014-09-04T12:23:34Z"

Timestamp (RFC 3339)

id: String!

Unique key identifier. See also: Unique Identifiers

Example: "ke_EQzGqWoY"

name: String!

The name of the key

Example: "unnamed"

permissions: [String!]!

A set of permission bits valid for this key

roles: [Role]

Roles this key inherits permission bits from

Expandable

Permission bit: "roles.read"

sales_channel: SalesChannel

Sales channel associated with this order

Expandable

Permission bit: "sales_channels.read"

token: String!

Javascript Web Token itself

user_id: String!

Unique user identifier (owner of the key)

Example: "us_EQzGqWoY"

Used By

Mutations

keysCreate, keysModify

Queries

keys

Types

Workflow

Preview (typescript)

Loading module