GitHub: Get a private registry for an organization

← Private registries operations · Get started

Operation github.private_registries_get_org_private_registry

Provider route: GET /orgs/{org}/private-registries/{secret_name}. 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["privateRegistries"]["privateRegistriesGetOrgPrivateRegistry"]>[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.privateRegistries.privateRegistriesGetOrgPrivateRegistry(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.private_registries.private_registries_get_org_private_registry(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.org	string	Required within parent
path.secret_name	string	Required within parent

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
$	Model	Root	Expand Get a private registry for an organization — response body

Referenced models: Get a private registry for an organization — response body

Schemas

Get a private registry for an organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Private registry configuration for an organization
account_id	string	Optional	The AWS account ID.
api_host	string	Optional	The Cloudsmith API host.
audience	string	Optional	The OIDC audience.
auth_type	string	Optional	The authentication type for the private registry. Known values: token, username_password, oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, oidc_gcp, anonymous
aws_region	string	Optional	The AWS region.
client_id	string	Optional	The client ID of the Azure AD application.
created_at	string	Required within parent	Format: date-time
domain	string	Optional	The CodeArtifact domain.
domain_owner	string	Optional	The CodeArtifact domain owner.
identity_mapping_name	string	Optional	The JFrog identity mapping name.
jfrog_oidc_provider_name	string	Optional	The JFrog OIDC provider name.
name	string	Required within parent	The name of the private registry configuration.
namespace	string	Optional	The Cloudsmith organization namespace.
registry_type	string	Required within parent	The registry type. Known values: maven_repository, nuget_feed, goproxy_server, npm_registry, rubygems_server, cargo_registry, composer_repository, docker_registry, git_source, helm_registry, hex_organization, hex_repository, pub_repository, python_index, terraform_registry
replaces_base	boolean	Optional	Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. Default: false
role_name	string	Optional	The AWS IAM role name.
service_account	string	Optional	The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).
service_slug	string	Optional	The Cloudsmith service account slug.
tenant_id	string	Optional	The tenant ID of the Azure AD application.
updated_at	string	Required within parent	Format: date-time
url	string	Optional	The URL of the private registry. Format: uri
username	JSON	Optional
username (anyOf 1)	string	Alternative	The username to use when authenticating with the private registry.
username (anyOf 2)	null	Alternative
visibility	string	Required within parent	Which type of organization repositories have access to the private registry. Known values: all, private, selected
workload_identity_provider	string	Optional	The full resource name of the GCP Workload Identity Provider (e.g. `projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>`).

Policy, approvals and errors

SDK function policy ID: github.private_registries_get_org_private_registry. Catalog operation: private-registries/get-org-private-registry. 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