code-security

Attach a configuration to repositories

Changed on

Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration.

If insufficient GHAS licenses are available to attach the configuration to a repository, only free features will be enabled.

The authenticated user must be an administrator or security manager for the organization to use this endpoint.

Directly applying an enterprise-enforced configuration also requires permission to manage the enterprise's code security settings. Without it, the request returns 403 and no repositories change.

When applying a different configuration, repositories with active enterprise-enforced attachments are skipped unless the authenticated user can manage the enterprise's code security settings; the remaining repositories are updated. The request still returns 202 if every repository is skipped.

OAuth app tokens and classic PATs require the write:org scope. Directly applying an enterprise-enforced configuration also requires admin:enterprise and is not supported by fine-grained PATs or GitHub App access tokens.

post/orgs/{org}/code-security/configurations/{configuration_id}/attach

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/code-security/configurations/{configuration_id}/attach
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

configuration_idinteger required

The unique identifier of the code security configuration.

Request body

scope'all' | 'all_without_configurations' | 'public' | 'private_or_internal' | 'selected' required

The type of repositories to attach the configuration to. selected means the configuration will be attached to only the repositories specified by selected_repository_ids

selected_repository_idsinteger[]

An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the scope is set to selected.

Response

Accepted

object required

Changes

  • 2022-11-2848ac4e4971ddRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 2022-11-28a2954a79ff13Revision changes
    • info

      added the non-success response with the status