Skip to main content

ApiKeyCreate (Input)

Data for creating single API key belonging to operator specified in request endpoint

input ApiKeyCreate {
resourceList: [PermissionResource!]!
name: NotEmptyString!
description: String!
usagePurpose: String!
isSandboxOnly: Boolean!
}

Fields​

ApiKeyCreate.resourceList ● [PermissionResource!]! non-null enum​

ApiKeyCreate.name ● NotEmptyString! non-null scalar​

ApiKeyCreate.description ● String! non-null scalar​

ApiKeyCreate.usagePurpose ● String! non-null scalar​

Describes what the user intends to use this API key for. Set only on creation.

ApiKeyCreate.isSandboxOnly ● Boolean! non-null scalar​

If true, the API key can be used only on sandbox (non-production) environments. Requests made with it on production are rejected with 403 Forbidden.

Member Of​

createApiKey mutation