Share via

Project Enablement - Update

Service:
Advanced Security
API Version:
7.2-preview.3

Update the status of Advanced Security for the project

PATCH https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.3

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
project
 path True

string

Project ID or project name
api-version
 query True

string

Version of the API to use. This should be set to '7.2-preview.3' to use this version of the api.

Request Body

Name Type Description
codeSecurityFeatures

CodeSecurityFeatures

Includes code security features that can be enabled.
enablementOnCreateSettings

EnablementOnCreateSettings

Auto enablement setting for newly created repositories.
reposEnablementStatus

RepoEnablementSettings[]

A list of enablement statuses for repositories within the specified organization or project.
secretProtectionFeatures

SecretProtectionFeatures

Includes secret protection features that can be enabled.

Responses

Name Type Description
200 OK

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.advsec_manage Grants the ability to access sarif upload information, delete analysis, and update alerts

Definitions

Name Description
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Object
Name Type Description
codeQLEnabled

boolean

CodeQL enablement status set to False when disabled and True when enabled; Null is never explicitly set.
codeSecurityChangedBy

string (uuid)

The VSID of the last user who modified the enablement status of Code Security.
codeSecurityEnabled

boolean

Code Security enablement status set to False when disabled and True when enabled; Null is never explicitly set.
codeSecurityEnablementLastChangedDate

string (date-time)

The last time the status of Code Security for this repository was updated
dependencyScanningInjectionEnabled

boolean

Dependency Scanning Injection enablement status set to False when disabled and True when enabled; Null is never explicitly set.
If Advanced Security is NOT already enabled, behavior will depend on if Advanced Security is to be enabled/disabled. DependencyScanningInjectionEnabled will not affect anything in this scenario.
If Advanced Security is to be disabled, the value of DependencyScanningInjectionEnabled will have no effect.

EnablementOnCreateSettings

Object
Name Type Description
enableCodeSecurityOnCreate

boolean

Automatically enable Code Security on newly created repositories.
enableSecretProtectionOnCreate

boolean

Automatically enable Secret Protection on newly created repositories.

ProjectEnablementSettings

Object
Name Type Description
codeSecurityFeatures

CodeSecurityFeatures

Includes code security features that can be enabled.
enablementOnCreateSettings

EnablementOnCreateSettings

Auto enablement setting for newly created repositories.
reposEnablementStatus

RepoEnablementSettings[]

A list of enablement statuses for repositories within the specified organization or project.
secretProtectionFeatures

SecretProtectionFeatures

Includes secret protection features that can be enabled.

RepoEnablementSettings

Object
Name Type Description
codeSecurityFeatures

CodeSecurityFeatures

Includes Code Security features that can be enabled.
projectId

string (uuid)

The project Id
repositoryId

string (uuid)

The repository Id
secretProtectionFeatures

SecretProtectionFeatures

Includes Secret Protection features that can be enabled.

SecretProtectionFeatures

Object
Name Type Description
blockPushes

boolean

When true, pushes containing secrets will be blocked.
When false, pushes are scanned for secrets and are not blocked.
If includeAllProperties in the request is false, this value will be null.
secretProtectionChangedBy

string (uuid)

The VSID of the last user who modified the enablement status of Secret Protection.
secretProtectionEnabled

boolean

Secret Protection enablement status set to False when disabled and True when enabled; Null is never explicitly set.
secretProtectionEnablementLastChangedDate

string (date-time)

The last time the status of Secret Protection for this repository was updated