Skip to main content
GET
Ottenere il profilo di code scan

Autorizzazioni

Richiede un utente di servizio o un token di accesso personale con l’autorizzazione ViewAccountCodeScans a livello Enterprise.

Comportamento

Restituisce i metadati del profilo, la visibilità (di proprietà dell’organizzazione o condiviso a livello di account), i pattern glob di inclusione/esclusione e tutti i relativi campi di istruzioni (per indagini, comunicazioni e sorgenti di ingestione). Restituisce 404 se il profilo non esiste o non è visibile all’account Enterprise. L’equivalente con ambito organizzazione è Ottieni profilo di code scan (Organizzazione).

Autorizzazioni

Authorization
string
header
obbligatorio

Credenziale dell'utente del servizio (prefisso: cog_)

Parametri del percorso

profile_id
string
obbligatorio

Risposta

Risposta riuscita

Dettagli completi di un profilo di code scan, incluse le relative linee guida.

created_at
integer
obbligatorio

Data di creazione del profilo (secondi Unix).

description
string | null
obbligatorio

Descrizione del profilo, se presente.

exclude_globs
string[] | null
obbligatorio

Pattern glob dei file da escludere dalla scansione, se presenti.

include_globs
string[] | null
obbligatorio

Pattern glob dei file da includere nella scansione, se presenti.

ingestion_source_guidance
string | null
obbligatorio

Linee guida che descrivono la sorgente di ingestione, se presenti.

investigation_guidance
string | null
obbligatorio

Linee guida per la fase di indagine, se presenti.

mode
enum<string>
obbligatorio

Modalità del profilo: discover o ingest.

Opzioni disponibili:
discover,
ingest
name
string
obbligatorio

Nome del profilo.

org_id
string | null
obbligatorio

Organizzazione proprietaria del profilo. Null quando il profilo è condiviso a livello di account.

post_ingestion_guidance
string | null
obbligatorio

Linee guida per la fase successiva all'ingestione, se presenti.

profile_id
string
obbligatorio

Identificatore univoco del profilo.

remediation_guidance
string | null
obbligatorio

Linee guida per la fase di risoluzione, se presenti.

report_guidance
string | null
obbligatorio

Linee guida per la fase di report, se presenti.

scan_type
enum<string>
obbligatorio

Tipo di scansione configurato dal profilo.

Opzioni disponibili:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
threat_model_guidance
string | null
obbligatorio

Indicazioni che descrivono il modello di minaccia, se presente.

triage_guidance
string | null
obbligatorio

Indicazioni per la fase di triage, se presenti.

validation_guidance
string | null
obbligatorio

Indicazioni per la fase di validazione, se presenti.

visibility
enum<string>
obbligatorio

Indica se il profilo appartiene a una singola organizzazione o è condiviso a livello di account.

Opzioni disponibili:
org,
account
communication_guidance
string | null

Indicazioni per la fase di comunicazione (azioni sui risultati finali, ad es. notifica ai responsabili o agli stakeholder), se presenti.