Compartilhar via

Org Enablement - Get

Serviço:
Advanced Security
Versão da API:
7.2-preview.3

Obter o status atual da Segurança Avançada para a organização

GET https://advsec.dev.azure.com/{organization}/_apis/management/enablement?api-version=7.2-preview.3
Com parâmetros opcionais: 
GET https://advsec.dev.azure.com/{organization}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-preview.3

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.2-preview.3' para usar esta versão da api.
includeAllProperties
 query

boolean

Quando true, também determine se os pushes são bloqueados se eles contêm segredos

Respostas

Nome Tipo Description
200 OK

OrgEnablementSettings

operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do 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

Escopos

Nome Description
vso.advsec Concede a capacidade de ler alertas, instâncias de resultados, instâncias de resultados de análise

Definições

Nome Description
CodeSecurityFeatures
EnablementOnCreateSettings
OrgEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Objeto
Nome Tipo Description
codeQLEnabled

boolean

Status de habilitação do CodeQL definido como False quando desabilitado e True quando habilitado; Nulo nunca é definido explicitamente.
codeSecurityChangedBy

string (uuid)

O VSID do último usuário que modificou o status de habilitação do Code Security.
codeSecurityEnabled

boolean

Status de habilitação de Segurança de Código definido como False quando desabilitado e True quando habilitado; Nulo nunca é definido explicitamente.
codeSecurityEnablementLastChangedDate

string (date-time)

A última vez que o status da Segurança de Código para este repositório foi atualizado
dependencyScanningInjectionEnabled

boolean

Status de habilitação de Injeção de Verificação de Dependência definido como False quando desabilitado e True quando habilitado; Nulo nunca é definido explicitamente.
Se a Segurança Avançada NÃO estiver habilitada, o comportamento dependerá se a Segurança Avançada for habilitada/desabilitada. DependencyScanningInjectionEnabled não afetará nada neste cenário.
Se a Segurança Avançada for desabilitada, o valor de DependencyScanningInjectionEnabled não terá efeito.

EnablementOnCreateSettings

Objeto
Nome Tipo Description
enableBlockPushesOnCreate

boolean

Habilite automaticamente o bloqueio de pushes que contêm segredos quando a Proteção Secreta é habilitada automaticamente. Se EnableSecretProtectionOnCreate não for verdade, esse sinalizador será ignorado.
enableCodeQLOnCreate

boolean

Habilite automaticamente o CodeQL quando a Segurança de Código estiver habilitada automaticamente. Se EnableCodeSecurityOnCreate não for verdadeiro, esse sinalizador será ignorado.
enableCodeSecurityOnCreate

boolean

Habilite automaticamente a Segurança de Código em repositórios recém-criados.
enableDependabotOnCreate

boolean

Habilite automaticamente o Dependabot quando a Segurança de Código estiver habilitada automaticamente. Se EnableCodeSecurityOnCreate não for verdadeiro, esse sinalizador será ignorado.
enableDependencyScanningInjectionOnCreate

boolean

Habilite automaticamente a Injeção de Verificação de Dependência quando a Segurança de Código estiver habilitada automaticamente. Se EnableCodeSecurityOnCreate não for verdadeiro, esse sinalizador será ignorado.
enableSecretProtectionOnCreate

boolean

Habilite automaticamente a Proteção Secreta em repositórios recém-criados.

OrgEnablementSettings

Objeto
Nome Tipo Description
codeSecurityFeatures

CodeSecurityFeatures

Inclui recursos de segurança de código que podem ser habilitados.
enablementOnCreateSettings

EnablementOnCreateSettings

Configuração de habilitação automática para repositórios recém-criados.
reposEnablementStatus

RepoEnablementSettings[]

Uma lista de status de habilitação para repositórios dentro da organização ou projeto especificado.
secretProtectionFeatures

SecretProtectionFeatures

Inclui recursos de proteção secreta que podem ser habilitados.

RepoEnablementSettings

Objeto
Nome Tipo Description
codeSecurityFeatures

CodeSecurityFeatures

Inclui recursos de Segurança de Código que podem ser habilitados.
projectId

string (uuid)

O ID do projeto
repositoryId

string (uuid)

A ID do repositório
secretProtectionFeatures

SecretProtectionFeatures

Inclui recursos da Proteção de Segredo que podem ser habilitados.

SecretProtectionFeatures

Objeto
Nome Tipo Description
blockPushes

boolean

Quando verdadeiro, os pushes que contêm segredos serão bloqueados.
Quando falso, os pushes são verificados em busca de segredos e não são bloqueados.
Se includeAllProperties na solicitação for false, esse valor será nulo.
secretProtectionChangedBy

string (uuid)

O VSID do último usuário que modificou o status de habilitação da Proteção Secreta.
secretProtectionEnabled

boolean

Status de habilitação da Proteção secreta definido como False quando desabilitado e True quando habilitado; Nulo nunca é definido explicitamente.
secretProtectionEnablementLastChangedDate

string (date-time)

A última vez que o status da Proteção Secreta para este repositório foi atualizado