Mutations
deleteApiKey
Permanently revoke an API key. The deleted key is returned for confirmation. System-managed keys cannot be deleted. Requires the apiKey:delete permission.
MUTATION
deleteApiKey(input: DeleteApiKeyInput!): DeleteApiKeyOutput!Arguments
input
required
Returns
apiKey
error
Mutation
mutation DeleteApiKey($input: DeleteApiKeyInput!) {
deleteApiKey(input: $input) {
apiKey {
id
description
permissions
createdBy {
__typename
... on UserActor {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
updatedBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"apiKeyId": "id"
}
}Response
{
"data": {
"deleteApiKey": {
"apiKey": {
"id": "id",
"description": "string",
"permissions": [
"string"
],
"createdBy": {
"__typename": "UserActor"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"updatedBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?
⌘I
Mutation
mutation DeleteApiKey($input: DeleteApiKeyInput!) {
deleteApiKey(input: $input) {
apiKey {
id
description
permissions
createdBy {
__typename
... on UserActor {
__typename
}
}
createdAt {
unixTimestamp
iso8601
}
updatedBy {
__typename
... on UserActor {
__typename
}
}
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"apiKeyId": "id"
}
}Response
{
"data": {
"deleteApiKey": {
"apiKey": {
"id": "id",
"description": "string",
"permissions": [
"string"
],
"createdBy": {
"__typename": "UserActor"
},
"createdAt": {
"unixTimestamp": "string",
"iso8601": "string"
},
"updatedBy": {
"__typename": "UserActor"
}
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}
