Skip to main content

ApiKeyQueries

No description

type ApiKeyQueries {
  listApiKeys: [OrgApiKey!]
  listMyApiKeys: [OrgApiKey!]
  listKeysForEndpoint(
    processPublicId: String!
  ): [OrgApiKey!]
}

Fields​

ApiKeyQueries.listApiKeys ● [OrgApiKey!] list object​

List active organization and personal API keys with owner and approximate usage metadata; key material is never returned. Requires canManageApiKeys and a user session.

ApiKeyQueries.listMyApiKeys ● [OrgApiKey!] list object​

List your active personal API keys in the current organization. Requires an enabled member user session.

ApiKeyQueries.listKeysForEndpoint ● [OrgApiKey!] list object​

Active API keys scoped to invoke the given endpoint (process public id): every one for a caller with canManageApiKeys, otherwise only the caller's own personal keys. Requires a user session.

ApiKeyQueries.listKeysForEndpoint.processPublicId ● String! non-null scalar​

Returned By​

apiKeys query