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
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! non-null object

ApiKey.revokedAt ● ISO8601DateTime scalar

ApiKey.revokedUser ● PortalUserBasicInfoType object

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