GitHub: List GPG keys for the authenticated user

GitHub users.usersListGpgKeysForAuthenticatedUser: arguments, response, policy and SDK examples.

Operation github.users_list_gpg_keys_for_authenticated_user

Provider route: GET /user/gpg_keys. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["users"]["usersListGpgKeysForAuthenticatedUser"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.users.usersListGpgKeysForAuthenticatedUser(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.users.users_list_gpg_keys_for_authenticated_user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Optional	Additional keys: not allowed
`query.per_page`	integer	Optional	Default: 30
`query.page`	integer	Optional	Default: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand Get a GPG key for the authenticated user — response body

Referenced models: Get a GPG key for the authenticated user — response body

Schemas

Get a GPG key for the authenticated user — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A unique encryption key
`can_certify`	boolean	Required within parent
`can_encrypt_comms`	boolean	Required within parent
`can_encrypt_storage`	boolean	Required within parent
`can_sign`	boolean	Required within parent
`created_at`	string	Required within parent	Format: date-time
`emails`	array	Required within parent
`emails[]`	object	Each item
`emails[].email`	string	Optional
`emails[].verified`	boolean	Optional
`expires_at`	JSON	Required within parent
`expires_at (anyOf 1)`	string	Alternative	Format: date-time
`expires_at (anyOf 2)`	null	Alternative
`id`	JSON	Required within parent
`id (anyOf 1)`	integer	Alternative	Format: int64
`id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`key_id`	string	Required within parent
`name`	JSON	Optional
`name (anyOf 1)`	string	Alternative
`name (anyOf 2)`	null	Alternative
`primary_key_id`	JSON	Required within parent
`primary_key_id (anyOf 1)`	JSON	Alternative
`primary_key_id (anyOf 1) (anyOf 1)`	integer	Alternative
`primary_key_id (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`primary_key_id (anyOf 2)`	null	Alternative
`public_key`	string	Required within parent
`raw_key`	JSON	Required within parent
`raw_key (anyOf 1)`	string	Alternative
`raw_key (anyOf 2)`	null	Alternative
`revoked`	boolean	Required within parent
`subkeys`	array	Required within parent
`subkeys[]`	object	Each item
`subkeys[].can_certify`	boolean	Optional
`subkeys[].can_encrypt_comms`	boolean	Optional
`subkeys[].can_encrypt_storage`	boolean	Optional
`subkeys[].can_sign`	boolean	Optional
`subkeys[].created_at`	string	Optional
`subkeys[].emails`	array	Optional
`subkeys[].emails[]`	object	Each item
`subkeys[].emails[].email`	string	Optional
`subkeys[].emails[].verified`	boolean	Optional
`subkeys[].expires_at`	JSON	Optional
`subkeys[].expires_at (anyOf 1)`	string	Alternative
`subkeys[].expires_at (anyOf 2)`	null	Alternative
`subkeys[].id`	JSON	Optional
`subkeys[].id (anyOf 1)`	integer	Alternative	Format: int64
`subkeys[].id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`subkeys[].key_id`	string	Optional
`subkeys[].primary_key_id`	JSON	Optional
`subkeys[].primary_key_id (anyOf 1)`	integer	Alternative
`subkeys[].primary_key_id (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`subkeys[].public_key`	string	Optional
`subkeys[].raw_key`	JSON	Optional
`subkeys[].raw_key (anyOf 1)`	string	Alternative
`subkeys[].raw_key (anyOf 2)`	null	Alternative
`subkeys[].revoked`	boolean	Optional
`subkeys[].subkeys`	array	Optional
`subkeys[].subkeys[]`	JSON	Each item

Policy, approvals and errors

SDK function policy ID: github.users_list_gpg_keys_for_authenticated_user. Catalog operation: users/list-gpg-keys-for-authenticated-user. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page