Compartir a través de

Project Enablement - Get

Servicio:
Advanced Security
Versión de la API:
7.2-preview.3

Obtener el estado actual de Advanced Security para un proyecto

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.3
Con parámetros opcionales: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-preview.3

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

Nombre de la organización de Azure DevOps.
project
 path True

string

Id. de proyecto o nombre del proyecto
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.2-preview.3" para usar esta versión de la API.
includeAllProperties
 query

boolean

Cuando es true, determine también si las inserciones están bloqueadas si contienen secretos.

Respuestas

Nombre Tipo Description
200 OK

ProjectEnablementSettings

operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre Description
vso.advsec Concede la capacidad de leer alertas, instancias de resultado, instancias de resultado de análisis

Definiciones

Nombre Description
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Objeto
Nombre Tipo Description
codeQLEnabled

boolean

CodeQL default setup enablement status set to False when not using default setup and True when using default setup; Null nunca se establece explícitamente.
codeSecurityChangedBy

string (uuid)

VSID del último usuario que modificó el estado de habilitación de Code Security.
codeSecurityEnabled

boolean

Estado de habilitación de seguridad de código establecido en False cuando está deshabilitado y True cuando está habilitado; Null nunca se establece explícitamente.
codeSecurityEnablementLastChangedDate

string (date-time)

La última vez que se actualizó el estado de Seguridad de código para este repositorio
dependencyScanningInjectionEnabled

boolean

Estado de habilitación de inserción de análisis de dependencias establecido en False cuando está deshabilitado y True cuando está habilitado; Null nunca se establece explícitamente.
Si Advanced Security no está habilitado, el comportamiento dependerá de si Advanced Security se va a habilitar o deshabilitar. DependencyScanningInjectionEnabled no afectará a nada en este escenario.
Si Advanced Security se va a deshabilitar, el valor de DependencyScanningInjectionEnabled no tendrá ningún efecto.

EnablementOnCreateSettings

Objeto
Nombre Tipo Description
enableBlockPushesOnCreate

boolean

Habilita automáticamente el bloqueo de inserciones que contienen secretos cuando la protección de secretos está habilitada automáticamente. Si EnableSecretProtectionOnCreate no es true, esta marca se omite.
enableCodeQLOnCreate

boolean

Habilite automáticamente CodeQL cuando la seguridad de código esté habilitada automáticamente. Si EnableCodeSecurityOnCreate no es true, esta marca se omite.
enableCodeSecurityOnCreate

boolean

Habilite automáticamente Code Security en repositorios recién creados.
enableDependabotOnCreate

boolean

Habilite automáticamente Dependabot cuando Code Security esté habilitado automáticamente. Si EnableCodeSecurityOnCreate no es true, esta marca se omite.
enableDependencyScanningInjectionOnCreate

boolean

Habilite automáticamente la inserción de análisis de dependencias cuando la seguridad del código esté habilitada automáticamente. Si EnableCodeSecurityOnCreate no es true, esta marca se omite.
enableSecretProtectionOnCreate

boolean

Habilite automáticamente Secret Protection en repositorios recién creados.

ProjectEnablementSettings

Objeto
Nombre Tipo Description
codeSecurityFeatures

CodeSecurityFeatures

Incluye características de seguridad de código que se pueden habilitar.
enablementOnCreateSettings

EnablementOnCreateSettings

Configuración de habilitación automática para repositorios recién creados.
reposEnablementStatus

RepoEnablementSettings[]

Lista de estados de habilitación para repositorios dentro de la organización o proyecto especificados.
secretProtectionFeatures

SecretProtectionFeatures

Incluye características de protección de secretos que se pueden habilitar.

RepoEnablementSettings

Objeto
Nombre Tipo Description
codeSecurityFeatures

CodeSecurityFeatures

Incluye características de seguridad de código que se pueden habilitar.
projectId

string (uuid)

El ID del proyecto
repositoryId

string (uuid)

El ID del repositorio
secretProtectionFeatures

SecretProtectionFeatures

Incluye características de Protección de secretos que se pueden habilitar.

SecretProtectionFeatures

Objeto
Nombre Tipo Description
blockPushes

boolean

Cuando es true, se bloquearán las inserciones que contienen secretos.
Cuando es false, las inserciones se examinan para los secretos y no se bloquean.
Si includeAllProperties en la solicitud es false, este valor será NULL.
secretProtectionChangedBy

string (uuid)

VSID del último usuario que modificó el estado de habilitación de Protección secreta.
secretProtectionEnabled

boolean

Estado de habilitación de Protección secreta establecido en False cuando está deshabilitado y True cuando está habilitado; Null nunca se establece explícitamente.
secretProtectionEnablementLastChangedDate

string (date-time)

La última vez que se actualizó el estado de Protección secreta para este repositorio