Skip to main content
GET
Récupérer le profil d’analyse de code

Autorisations

Nécessite un utilisateur de service ou un jeton d’accès personnel avec l’autorisation ViewCodeScans au niveau de l’organisation.

Comportement

Renvoie les métadonnées du profil, sa visibilité (appartenant à l’organisation ou partagé à l’échelle du compte), les globs d’inclusion/exclusion et tous ses champs d’instructions (investigation, communication et source d’ingestion). Pour trouver les ID de profil, consultez Lister les profils d’analyse de code. Renvoie 404 si le profil n’existe pas ou n’est pas visible par l’organisation.

Autorisations

Authorization
string
header
requis

Identifiant de compte de service (préfixe : cog_)

Paramètres de chemin

profile_id
string
requis
org_id
string
requis

ID de l’organisation (préfixe : org-)

Exemple:

"org-abc123def456"

Réponse

Réponse réussie

Détails complets d’un profil d’analyse de code, y compris ses instructions.

created_at
integer
requis

Horodatage de création du profil (secondes Unix).

description
string | null
requis

Description du profil, le cas échéant.

exclude_globs
string[] | null
requis

Motifs glob des fichiers à exclure de l’analyse, le cas échéant.

include_globs
string[] | null
requis

Motifs glob des fichiers à inclure dans l’analyse, le cas échéant.

ingestion_source_guidance
string | null
requis

Instructions décrivant la source d’ingestion, le cas échéant.

investigation_guidance
string | null
requis

Instructions pour la phase d’investigation, le cas échéant.

mode
enum<string>
requis

Mode du profil : discover ou ingest.

Options disponibles:
discover,
ingest
name
string
requis

Nom du profil.

org_id
string | null
requis

Organisation propriétaire du profil. Null si le profil est partagé à l’échelle du compte.

post_ingestion_guidance
string | null
requis

Instructions pour la phase post-ingestion, le cas échéant.

profile_id
string
requis

Identifiant unique du profil.

remediation_guidance
string | null
requis

Instructions pour la phase de remédiation, le cas échéant.

report_guidance
string | null
requis

Instructions pour la phase de génération du rapport, le cas échéant.

scan_type
enum<string>
requis

Type d’analyse configuré par le profil.

Options disponibles:
security,
performance,
db-queries,
test-coverage,
dead-code,
code-quality,
telemetry,
accessibility,
general,
migration-docs
threat_model_guidance
string | null
requis

Consignes décrivant le modèle de menace, le cas échéant.

triage_guidance
string | null
requis

Consignes pour la phase de triage, le cas échéant.

validation_guidance
string | null
requis

Consignes pour la phase de validation, le cas échéant.

visibility
enum<string>
requis

Indique si le profil appartient à une seule organisation ou s’il est partagé à l’échelle du compte.

Options disponibles:
org,
account
communication_guidance
string | null

Instructions pour la phase de communication (traitement des constats finaux, par ex. notification des responsables ou des parties prenantes), le cas échéant.