Skip to main content

DeleteApiKeyPayload

The output of our delete ApiKey mutation.

type DeleteApiKeyPayload {
clientMutationId: String
apiKey: ApiKey
deletedApiKeyNodeId: ID
query: Query
account: Account
workspace: Workspace
createdByWorkspaceAccount: WorkspaceAccount
apiKeyEdge(
orderBy: [ApiKeysOrderBy!] = [PRIMARY_KEY_ASC]
): ApiKeysEdge
}

Fields​

DeleteApiKeyPayload.clientMutationId ● String scalar​

The exact same clientMutationId that was provided in the mutation input, unchanged and unused. May be used by a client to track mutations.

DeleteApiKeyPayload.apiKey ● ApiKey object​

The ApiKey that was deleted by this mutation.

DeleteApiKeyPayload.deletedApiKeyNodeId ● ID scalar​

DeleteApiKeyPayload.query ● Query object​

Our root query field type. Allows us to run any query from our mutation payload.

DeleteApiKeyPayload.account ● Account object​

Reads a single Account that is related to this ApiKey.

DeleteApiKeyPayload.workspace ● Workspace object​

Reads a single Workspace that is related to this ApiKey.

DeleteApiKeyPayload.createdByWorkspaceAccount ● WorkspaceAccount object​

Reads a single WorkspaceAccount that is related to this ApiKey.

DeleteApiKeyPayload.apiKeyEdge ● ApiKeysEdge object​

An edge for our ApiKey. May be used by Relay 1.

DeleteApiKeyPayload.apiKeyEdge.orderBy ● [ApiKeysOrderBy!] list enum​

The method to use when ordering ApiKey.

Returned By​

deleteApiKey mutation