Skip to main content

ApiKeyUpdate (Input)

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

input ApiKeyUpdate {
apiKeyNid: Int!
resourceList: [PermissionResource!]!
name: NotEmptyString!
description: String!
serviceAccount: ApiLoginNidScalar!
isSandboxOnly: Boolean
}

Fields​

ApiKeyUpdate.apiKeyNid ● Int! non-null scalar​

API key numeric identifier

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

ApiKeyUpdate.name ● NotEmptyString! non-null scalar​

ApiKeyUpdate.description ● String! non-null scalar​

ApiKeyUpdate.serviceAccount ● ApiLoginNidScalar! non-null scalar​

ApiKeyUpdate.isSandboxOnly ● Boolean 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. If null, the current value is left unchanged.

Member Of​

modifyApiKey mutation