Create a private registry for an organization
Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." For OIDC-based registries (oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp), the encrypted_value and key_id fields should be omitted.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Path parameters
The organization name. The name is not case sensitive.
Request body
The registry type.
The URL of the private registry.
The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to true, Dependabot will only use this registry and will not fall back to the public registry. When set to false (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.
The ID of the key you used to encrypt the secret. Required when auth_type is token or username_password. Should be omitted for OIDC auth types.
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.
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility is set to selected. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility is set to all or private.
The authentication type for the private registry. Defaults to token if not specified. Use oidc_azure, oidc_aws, oidc_jfrog, oidc_cloudsmith, or oidc_gcp for OIDC authentication.
The tenant ID of the Azure AD application. Required when auth_type is oidc_azure.
The client ID of the Azure AD application. Required when auth_type is oidc_azure.
The AWS region. Required when auth_type is oidc_aws.
The AWS account ID. Required when auth_type is oidc_aws.
The AWS IAM role name. Required when auth_type is oidc_aws.
The CodeArtifact domain. Required when auth_type is oidc_aws.
The CodeArtifact domain owner (AWS account ID). Required when auth_type is oidc_aws.
The JFrog OIDC provider name. Required when auth_type is oidc_jfrog.
The OIDC audience. Optional for oidc_aws, oidc_jfrog, and oidc_gcp, and required for oidc_cloudsmith auth types.
The JFrog identity mapping name. Optional for oidc_jfrog auth type.
The Cloudsmith organization namespace. Required when auth_type is oidc_cloudsmith.
The Cloudsmith service account slug. Required when auth_type is oidc_cloudsmith.
The Cloudsmith API host. Optional for oidc_cloudsmith auth type. If omitted, api.cloudsmith.io is used by default.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>). Required when auth_type is oidc_gcp.
The GCP service account email to impersonate. Optional for oidc_gcp auth type. If omitted, the federated token is used directly (direct WIF).
Response
The organization private registry configuration
The name of the private registry configuration.
The registry type.
The authentication type for the private registry.
The URL of the private registry.
The username to use when authenticating with the private registry.
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.
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.
An array of repository IDs that can access the organization private registry when visibility is set to selected.
The tenant ID of the Azure AD application.
The client ID of the Azure AD application.
The AWS region.
The AWS account ID.
The AWS IAM role name.
The CodeArtifact domain.
The CodeArtifact domain owner.
The JFrog OIDC provider name.
The OIDC audience.
The JFrog identity mapping name.
The Cloudsmith organization namespace.
The Cloudsmith service account slug.
The Cloudsmith API host.
The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>).
The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).
Example response
{
"name": "MAVEN_REPOSITORY_SECRET",
"username": "monalisa"
}