Enable or disable a security feature for an organization

Deprecated

POST

/orgs/{org}/{security_product}/{enablement}

[!WARNING] Closing down notice: The ability to enable or disable a security feature for all eligible repositories in an organization is closing down. Please use code security configurations instead. For more information, see the changelog.

Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see “Managing security managers in your organization.”

The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the admin:org, write:org, or repo scopes to use this endpoint.

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

security_product

required

string

Allowed values: dependency_graph dependabot_alerts dependabot_security_updates advanced_security code_scanning_default_setup secret_scanning secret_scanning_push_protection

The security feature to enable or disable.

enablement

required

string

Allowed values: enable_all disable_all

The action to take.

enable_all means to enable the specified security feature for all repositories in the organization. disable_all means to disable the specified security feature for all repositories in the organization.

Request Body

Media type application/json

object

query_suite

CodeQL query suite to be used. If you specify the query_suite parameter, the default setup will be configured with this query suite only on all repositories that didn’t have default setup already configured. It will not change the query suite on repositories that already have default setup configured. If you don’t specify any query_suite in your request, the preferred query suite of the organization will be applied.

string

Allowed values: default extended

Examples

Example default

null

Responses

204

Action started

422

The action could not be taken due to an in progress enablement, or a policy is preventing enablement