Udostępnij przez

Project Enablement - Get

Usługa:
Advanced Security
Wersja interfejsu API:
7.2-preview.3

Pobieranie bieżącego stanu usługi Advanced Security dla projektu

GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?api-version=7.2-preview.3
Z parametrami opcjonalnymi: 
GET https://advsec.dev.azure.com/{organization}/{project}/_apis/management/enablement?includeAllProperties={includeAllProperties}&api-version=7.2-preview.3

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
 path True

string

Nazwa organizacji usługi Azure DevOps.
project
 path True

string

Identyfikator projektu lub nazwa projektu
api-version
 query True

string

Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna mieć wartość "7.2-preview.3".
includeAllProperties
 query

boolean

W przypadku wartości true ustal również, czy wypchnięcia są blokowane, jeśli zawierają wpisy tajne

Odpowiedzi

Nazwa Typ Opis
200 OK

ProjectEnablementSettings

operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa Opis
vso.advsec Przyznaje możliwość odczytywania alertów, wystąpień wyników, wystąpień wyników analizy

Definicje

Nazwa Opis
CodeSecurityFeatures
EnablementOnCreateSettings
ProjectEnablementSettings
RepoEnablementSettings
SecretProtectionFeatures

CodeSecurityFeatures

Objekt
Nazwa Typ Opis
codeQLEnabled

boolean

Stan włączania codeQL jest ustawiony na Wartość Fałsz, gdy jest wyłączona i Prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
codeSecurityChangedBy

string (uuid)

Identyfikator VSID ostatniego użytkownika, który zmodyfikował stan włączania zabezpieczeń kodu.
codeSecurityEnabled

boolean

Stan włączania zabezpieczeń kodu ma wartość Fałsz, gdy jest wyłączona i Prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
codeSecurityEnablementLastChangedDate

string (date-time)

Ostatni raz stan zabezpieczeń kodu dla tego repozytorium został zaktualizowany
dependencyScanningInjectionEnabled

boolean

Stan włączania iniekcji skanowania zależności ma wartość False, gdy jest wyłączona i prawda po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
Jeśli zabezpieczenia zaawansowane nie są jeszcze włączone, zachowanie będzie zależeć od tego, czy usługa Advanced Security ma być włączona/wyłączona. DependencyScanningInjectionEnabled nie wpłynie na nic w tym scenariuszu.
Jeśli usługa Advanced Security ma zostać wyłączona, wartość DependencyScanningInjectionEnabled nie będzie działać.

EnablementOnCreateSettings

Objekt
Nazwa Typ Opis
enableBlockPushesOnCreate

boolean

Automatyczne włączanie blokowania wypychań zawierających wpisy tajne, gdy funkcja Secret Protection jest włączona automatycznie. Jeśli ustawienie EnableSecretProtectionOnCreate nie jest prawdziwe, ta flaga jest ignorowana.
enableCodeQLOnCreate

boolean

Automatycznie włącz kodQL, gdy zabezpieczenia kodu są włączone automatycznie. Jeśli wartość EnableCodeSecurityOnCreate nie jest prawdziwa, ta flaga jest ignorowana.
enableCodeSecurityOnCreate

boolean

Automatycznie włącz zabezpieczenia kodu w nowo utworzonych repozytoriach.
enableDependabotOnCreate

boolean

Automatycznie włącz funkcję Dependabot, gdy zabezpieczenia kodu są włączone automatycznie. Jeśli wartość EnableCodeSecurityOnCreate nie jest prawdziwa, ta flaga jest ignorowana.
enableDependencyScanningInjectionOnCreate

boolean

Automatyczne włączanie wstrzykiwania skanowania zależności po automatycznym włączeniu zabezpieczeń kodu. Jeśli wartość EnableCodeSecurityOnCreate nie jest prawdziwa, ta flaga jest ignorowana.
enableSecretProtectionOnCreate

boolean

Automatyczne włączanie ochrony wpisów tajnych w nowo utworzonych repozytoriach.

ProjectEnablementSettings

Objekt
Nazwa Typ Opis
codeSecurityFeatures

CodeSecurityFeatures

Zawiera funkcje zabezpieczeń kodu, które można włączyć.
enablementOnCreateSettings

EnablementOnCreateSettings

Ustawienie automatycznego włączania dla nowo utworzonych repozytoriów.
reposEnablementStatus

RepoEnablementSettings[]

Lista stanów włączania dla repozytoriów w określonej organizacji lub projekcie.
secretProtectionFeatures

SecretProtectionFeatures

Obejmuje funkcje ochrony wpisów tajnych, które można włączyć.

RepoEnablementSettings

Objekt
Nazwa Typ Opis
codeSecurityFeatures

CodeSecurityFeatures

Zawiera funkcje zabezpieczeń kodu, które można włączyć.
projectId

string (uuid)

Identyfikator projektu
repositoryId

string (uuid)

Identyfikator repozytorium
secretProtectionFeatures

SecretProtectionFeatures

Obejmuje funkcje ochrony wpisów tajnych, które można włączyć.

SecretProtectionFeatures

Objekt
Nazwa Typ Opis
blockPushes

boolean

Jeśli wartość true, wypchnięcia zawierające wpisy tajne zostaną zablokowane.
W przypadku wartości false wypychania są skanowane pod kątem wpisów tajnych i nie są blokowane.
Jeśli właściwość includeAllProperties w żądaniu ma wartość false, ta wartość będzie mieć wartość null.
secretProtectionChangedBy

string (uuid)

Identyfikator VSID ostatniego użytkownika, który zmodyfikował stan włączania ochrony wpisów tajnych.
secretProtectionEnabled

boolean

Stan włączania ochrony wpisów tajnych ma wartość Fałsz w przypadku wyłączenia i wartości True po włączeniu; Wartość null nigdy nie jest jawnie ustawiana.
secretProtectionEnablementLastChangedDate

string (date-time)

Ostatni raz stan ochrony wpisów tajnych dla tego repozytorium został zaktualizowany