Partager via

Project Enablement - Get

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

Obtenir l’état actuel de Advanced Security pour un projet

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.3
Avec des paramètres facultatifs: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-preview.3

Paramètres URI

Nom Dans Obligatoire Type Description
organization
 path True

string

Nom de l’organisation Azure DevOps.
project
 path True

string

ID de projet ou nom du projet
api-version
 query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.2-preview.3 » pour utiliser cette version de l’API.
includeAllProperties
 query

boolean

Quand la valeur est true, déterminez également si les envois sont bloqués s’ils contiennent des secrets

Réponses

Nom Type Description
200 OK

ProjectEnablementSettings

opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.advsec Accorde la possibilité de lire des alertes, des instances de résultats, des instances de résultat d’analyse

Définitions

Nom Description
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Objet
Nom Type Description
codeQLEnabled

boolean

L’état d’activation du programme d’installation par défaut de CodeQL a la valeur False quand il n’utilise pas la configuration par défaut et True lors de l’utilisation de l’installation par défaut ; La valeur Null n’est jamais définie explicitement.
codeSecurityChangedBy

string (uuid)

VSID du dernier utilisateur qui a modifié l’état d’activation de Code Security.
codeSecurityEnabled

boolean

L’état d’activation de la sécurité du code a la valeur False lorsqu’il est désactivé et True lorsqu’il est activé ; La valeur Null n’est jamais définie explicitement.
codeSecurityEnablementLastChangedDate

string (date-time)

La dernière fois que l’état de sécurité du code pour ce référentiel a été mis à jour
dependencyScanningInjectionEnabled

boolean

L’état d’activation de l’injection d’analyse des dépendances a la valeur False lorsqu’il est désactivé et True lorsqu’il est activé ; La valeur Null n’est jamais définie explicitement.
Si Advanced Security n’est pas déjà activé, le comportement dépend si Advanced Security doit être activé/désactivé. DependencyScanningInjectionEnabled n’affecte rien dans ce scénario.
Si Advanced Security doit être désactivé, la valeur de DependencyScanningInjectionEnabled n’a aucun effet.

EnablementOnCreateSettings

Objet
Nom Type Description
enableBlockPushesOnCreate

boolean

Activez automatiquement le blocage des envois (push) qui contiennent des secrets lorsque secret Protection est activé automatiquement. Si EnableSecretProtectionOnCreate n’est pas vrai, cet indicateur est ignoré.
enableCodeQLOnCreate

boolean

Activez automatiquement CodeQL lorsque la sécurité du code est activée automatiquement. Si EnableCodeSecurityOnCreate n’est pas vrai, cet indicateur est ignoré.
enableCodeSecurityOnCreate

boolean

Activez automatiquement la sécurité du code sur les dépôts nouvellement créés.
enableDependabotOnCreate

boolean

Activez automatiquement Dependabot lorsque la sécurité du code est activée automatiquement. Si EnableCodeSecurityOnCreate n’est pas vrai, cet indicateur est ignoré.
enableDependencyScanningInjectionOnCreate

boolean

Activez automatiquement l’injection d’analyse des dépendances lorsque la sécurité du code est activée automatiquement. Si EnableCodeSecurityOnCreate n’est pas vrai, cet indicateur est ignoré.
enableSecretProtectionOnCreate

boolean

Activez automatiquement Secret Protection sur les dépôts nouvellement créés.

ProjectEnablementSettings

Objet
Nom Type Description
codeSecurityFeatures

CodeSecurityFeatures

Inclut les fonctionnalités de sécurité du code qui peuvent être activées.
enablementOnCreateSettings

EnablementOnCreateSettings

Paramètre d’activation automatique pour les dépôts nouvellement créés.
reposEnablementStatus

RepoEnablementSettings[]

Liste des états d’activation des référentiels au sein de l’organisation ou du projet spécifiés.
secretProtectionFeatures

SecretProtectionFeatures

Inclut les fonctionnalités de protection des secrets qui peuvent être activées.

RepoEnablementSettings

Objet
Nom Type Description
codeSecurityFeatures

CodeSecurityFeatures

Inclut les fonctionnalités de sécurité du code qui peuvent être activées.
projectId

string (uuid)

L’Id du projet
repositoryId

string (uuid)

L’ID du référentiel
secretProtectionFeatures

SecretProtectionFeatures

Inclut les fonctionnalités de protection secrète qui peuvent être activées.

SecretProtectionFeatures

Objet
Nom Type Description
blockPushes

boolean

Lorsque la valeur est true, les envois (push) contenant des secrets sont bloqués.
Lorsque la valeur est false, les push sont analysés pour les secrets et ne sont pas bloqués.
Si includeAllProperties dans la requête a la valeur false, cette valeur est null.
secretProtectionChangedBy

string (uuid)

VSID du dernier utilisateur qui a modifié l’état d’activation de la protection secrète.
secretProtectionEnabled

boolean

L’état d’activation de la protection secrète est False lorsqu’il est désactivé et True lorsqu’il est activé ; La valeur Null n’est jamais définie explicitement.
secretProtectionEnablementLastChangedDate

string (date-time)

La dernière fois que l’état de Secret Protection pour ce référentiel a été mis à jour