Get a private registry for an organization

GET

/orgs/{org}/private-registries/{secret_name}

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

secret_name

required

string

The name of the secret.

Responses

200

The specified private registry configuration for the organization

Media type application/json

Organization private registry

Private registry configuration for an organization

object

name

required

The name of the private registry configuration.

string

registry_type

required

The registry type.

string

Allowed 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

auth_type

The authentication type for the private registry.

string

Allowed values: token username_password oidc_azure oidc_aws oidc_jfrog oidc_cloudsmith oidc_gcp

url

The URL of the private registry.

string format: uri

username

The username to use when authenticating with the private registry.

string

nullable

replaces_base

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.

boolean

visibility

required

Which type of organization repositories have access to the private registry.

string

Allowed values: all private selected

tenant_id

The tenant ID of the Azure AD application.

string

client_id

The client ID of the Azure AD application.

string

aws_region

The AWS region.

string

account_id

The AWS account ID.

string

role_name

The AWS IAM role name.

string

domain

The CodeArtifact domain.

string

domain_owner

The CodeArtifact domain owner.

string

jfrog_oidc_provider_name

The JFrog OIDC provider name.

string

audience

The OIDC audience.

string

identity_mapping_name

The JFrog identity mapping name.

string

namespace

The Cloudsmith organization namespace.

string

service_slug

The Cloudsmith service account slug.

string

api_host

The Cloudsmith API host.

string

workload_identity_provider

The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>).

string

service_account

The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

Examples

Example default

{
  "name": "MAVEN_REPOSITORY_SECRET",
  "registry_type": "maven_repository",
  "username": "monalisa",
  "visibility": "private",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}