Skip to main content

ApiKey

Company-scoped API Key metadata (token is never exposed)

type ApiKey {
  accesses: [Access!]!
  company: Company
  createdAt: ISO8601DateTime!
  creatorUser: PortalUserBasicInfoType!
  description: String
  expiresAt: ISO8601DateTime
  id: ID!
  lastUsedAt: ISO8601DateTime
  name: String!
  profile: PortalUserAccessProfiles
  revokedAt: ISO8601DateTime
  revokedUser: PortalUserBasicInfoType
  rotatedAt: ISO8601DateTime
  serviceUser: PortalUserBasicInfoType!
  status: ApiKeyStatusEnum!
  teams: [Team!]
  type: ApiKeyTypeEnum!
  updatedAt: ISO8601DateTime!
}

Fields​

ApiKey.accesses ● [Access!]! non-null object​

ApiKey.company ● Company object​

ApiKey.createdAt ● ISO8601DateTime! non-null scalar​

ApiKey.creatorUser ● PortalUserBasicInfoType! non-null object​

ApiKey.description ● String scalar​

ApiKey.expiresAt ● ISO8601DateTime scalar​

ApiKey.id ● ID! non-null scalar​

ApiKey.lastUsedAt ● ISO8601DateTime scalar​

ApiKey.name ● String! non-null scalar​

ApiKey.profile ● PortalUserAccessProfiles object​

The service account's own profile in the key's company. Null for a personal key, which belongs to no company, and for a service key without a binding

ApiKey.revokedAt ● ISO8601DateTime scalar​

ApiKey.revokedUser ● PortalUserBasicInfoType object​

ApiKey.rotatedAt ● ISO8601DateTime scalar​

When this key replaced a previous one; null if it did not, or did before rotations were recorded

ApiKey.serviceUser ● PortalUserBasicInfoType! non-null object​

ApiKey.status ● ApiKeyStatusEnum! non-null enum​

ApiKey.teams ● [Team!] list object​

ApiKey.type ● ApiKeyTypeEnum! non-null enum​

ApiKey.updatedAt ● ISO8601DateTime! non-null scalar​

Returned By​

apiKey query

Member Of​

ApiKeyCollection object ● CreateApiKeyPayload object ● RegenerateApiKeyPayload object ● RevokeApiKeyPayload object ● UpdateApiKeyPayload object

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute

Resources

By exploring our content, you'll find resources that will enhance your understanding of the importance of a Security Application Program.

Conviso Blog: Explore our blog, which offers a collection of articles and posts covering a wide range of AppSec topics. The content on the blog is primarily in English.

Conviso's YouTube Channel: Access a wealth of informative videos covering various topics related to AppSec. Please note that the content is primarily in Portuguese.