Skip to main content

ApiKey

No description

type ApiKey implements Node {
  nodeId: ID!
  id: String!
  key: String!
  workspaceId: String
  accountId: String!
  keyVersion: Int!
  version: Int!
  deletedAt: Datetime
  updatedAt: Datetime!
  createdAt: Datetime!
  createdByWorkspaceAccountId: String
  name: String
  roleId: String
  isAgent: Boolean!
  account: Account
  workspace: Workspace
  createdByWorkspaceAccount: WorkspaceAccount
}

Fields​

ApiKey.nodeId ● ID! non-null scalar​

A globally unique identifier. Can be used in various places throughout the system to identify this single value.

ApiKey.id ● String! non-null scalar​

ApiKey.key ● String! non-null scalar​

ApiKey.workspaceId ● String scalar​

ApiKey.accountId ● String! non-null scalar​

ApiKey.keyVersion ● Int! non-null scalar​

ApiKey.version ● Int! non-null scalar​

ApiKey.deletedAt ● Datetime scalar​

ApiKey.updatedAt ● Datetime! non-null scalar​

ApiKey.createdAt ● Datetime! non-null scalar​

ApiKey.createdByWorkspaceAccountId ● String scalar​

ApiKey.name ● String scalar​

ApiKey.roleId ● String scalar​

ApiKey.isAgent ● Boolean! non-null scalar​

ApiKey.account ● Account object​

Reads a single Account that is related to this ApiKey.

ApiKey.workspace ● Workspace object​

Reads a single Workspace that is related to this ApiKey.

ApiKey.createdByWorkspaceAccount ● WorkspaceAccount object​

Reads a single WorkspaceAccount that is related to this ApiKey.

Interfaces​

Node interface​

An object with a globally unique ID.

Returned By​

apiKey query ● apiKeyByNodeId query ● apiKeys query

Member Of​

ApiKeysConnection object ● ApiKeysEdge object ● CreateApiKeyPayload object ● DeleteApiKeyPayload object