GitHub: Private registries schemas

← Private registries operations · All schemas

Create 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.
selected_repository_ids	array	Optional	An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.
selected_repository_ids[]	JSON	Each item
selected_repository_ids[] (anyOf 1)	integer	Alternative
selected_repository_ids[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
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	string	Optional	The username to use when authenticating with the private registry.
visibility	string	Required within parent	Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access 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>`).

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>`).