Skip to main content
GET
Code-Scan-Profil abrufen

Berechtigungen

Erfordert einen Service-Benutzer oder ein Personal Access Token mit der Berechtigung ViewCodeScans auf Organisationsebene.

Verhalten

Gibt die Metadaten des Profils, seine Sichtbarkeit (organisationsintern oder kontoweit freigegeben), Include-/Exclude-Globs sowie alle Leitlinienfelder (für Untersuchung, Kommunikation und Ingestion-Quellen) zurück. Profil-IDs finden Sie unter Code-Scan-Profile auflisten. Gibt 404 zurück, wenn das Profil nicht existiert oder für die Organisation nicht sichtbar ist.

Autorisierungen

Authorization
string
header
erforderlich

Servicebenutzer-Anmeldedaten (Präfix: cog_)

Pfadparameter

profile_id
string
erforderlich
org_id
string
erforderlich

Organisations-ID (Präfix: org-)

Beispiel:

"org-abc123def456"

Antwort

Erfolgreiche Antwort

Vollständige Details eines Code-Scan-Profils, einschließlich seiner Hinweise.

created_at
integer
erforderlich

Zeitpunkt, zu dem das Profil erstellt wurde (Unix-Sekunden).

description
string | null
erforderlich

Beschreibung des Profils, falls vorhanden.

exclude_globs
string[] | null
erforderlich

Glob-Muster für Dateien, die vom Scan ausgeschlossen werden sollen, falls vorhanden.

include_globs
string[] | null
erforderlich

Glob-Muster für Dateien, die in den Scan einbezogen werden sollen, falls vorhanden.

ingestion_source_guidance
string | null
erforderlich

Hinweise zur Ingestionsquelle, falls vorhanden.

investigation_guidance
string | null
erforderlich

Hinweise für die Untersuchungsphase, falls vorhanden.

mode
enum<string>
erforderlich

Profilmodus: discover oder ingest.

Verfügbare Optionen:
discover,
ingest
name
string
erforderlich

Name des Profils.

org_id
string | null
erforderlich

Organisation, der das Profil gehört. Null, wenn das Profil kontoweit freigegeben ist.

post_ingestion_guidance
string | null
erforderlich

Hinweise für die Phase nach der Ingestion, falls vorhanden.

profile_id
string
erforderlich

Eindeutige Kennung des Profils.

remediation_guidance
string | null
erforderlich

Hinweise für die Fehlerbehebungsphase, falls vorhanden.

report_guidance
string | null
erforderlich

Hinweise für die Berichtsphase, falls vorhanden.

scan_type
enum<string>
erforderlich

Typ des Scans, den das Profil konfiguriert.

Verfügbare Optionen:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
threat_model_guidance
string | null
erforderlich

Hinweise zum Bedrohungsmodell, falls vorhanden.

triage_guidance
string | null
erforderlich

Hinweise für die Triage-Phase, falls vorhanden.

validation_guidance
string | null
erforderlich

Hinweise für die Validierungsphase, falls vorhanden.

visibility
enum<string>
erforderlich

Gibt an, ob das Profil einer einzelnen Organisation gehört oder im gesamten Account geteilt wird.

Verfügbare Optionen:
org,
account
communication_guidance
string | null

Gegebenenfalls Hinweise für die Kommunikationsphase (Maßnahmen zu finalen Befunden, z. B. Benachrichtigung von Verantwortlichen oder Stakeholdern).