> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devinenterprise.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Obter perfil de varredura de código (API do Devin)
> Obtenha um perfil de varredura de código específico do Devin, incluindo modo, tipo de varredura, padrões glob de inclusão/exclusão e orientações, pela API de organização v3
## Permissões
Requer um [usuário de serviço](/pt-BR/api-reference/v3/service-users/members-service-users) ou um [token de acesso pessoal](/pt-BR/api-reference/personal-access-tokens) com a permissão `ViewCodeScans` no nível da organização.
## Comportamento
Retorna os metadados do perfil, a visibilidade (pertencente à organização ou compartilhado em nível da conta), os padrões glob de inclusão/exclusão e todos os campos de orientação (investigação, comunicação e origem de ingestão). Encontre IDs de perfil em [List perfis de varredura de código](/pt-BR/api-reference/v3/code-scans/organizations-code-scans-profiles).
Retorna `404` quando o perfil não existe ou não está visível para a organização.
## OpenAPI
````yaml pt-BR/v3-openapi.yaml GET /v3/organizations/{org_id}/code-scans/profiles/{profile_id}
openapi: 3.1.0
info:
description: API Devin v3 com autenticação de usuário de serviço e RBAC
title: Devin API v3
version: 3.0.0
servers: []
security:
- bearerAuth: []
paths:
/v3/organizations/{org_id}/code-scans/profiles/{profile_id}:
get:
tags:
- code-scans
summary: Obter perfil de varredura de código
description: >-
Obtenha um perfil de varredura de código por ID.
Retorna os metadados do perfil, sua visibilidade (pertencente à
organização ou compartilhado em nível da conta) e todos os seus campos
de orientação. Retorna ``404`` quando o perfil não existe ou não está
visível para a organização.
operationId: >-
handle_get_code_scan_profile_v3_organizations__org_id__code_scans_profiles__profile_id__get
parameters:
- in: path
name: profile_id
required: true
schema:
title: Profile Id
type: string
- description: 'ID da organização (prefixo: org-)'
in: path
name: org_id
required: true
schema:
example: org-abc123def456
title: Org Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CodeScanProfileDetailResponse'
description: Resposta bem-sucedida
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Não autorizado
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Proibido
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Não encontrado
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Conflito
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Conteúdo não processável
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: Muitas requisições
components:
schemas:
CodeScanProfileDetailResponse:
description: >-
Detalhes completos de um perfil de varredura de código, incluindo suas
orientações.
properties:
communication_guidance:
anyOf:
- type: string
- type: 'null'
description: >-
Orientação para a fase de comunicação (ações sobre os resultados
finais, por exemplo, notificar responsáveis ou partes interessadas),
se houver.
title: Communication Guidance
created_at:
description: Momento em que o perfil foi criado (segundos Unix).
title: Created At
type: integer
description:
anyOf:
- type: string
- type: 'null'
description: Descrição do perfil, se houver.
title: Description
exclude_globs:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: Padrões glob de arquivos a excluir da varredura, se houver.
title: Exclude Globs
include_globs:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: Padrões glob de arquivos a incluir na varredura, se houver.
title: Include Globs
ingestion_source_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientações que descrevem a origem da ingestão, se houver.
title: Ingestion Source Guidance
investigation_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientações para a fase de investigação, se houver.
title: Investigation Guidance
mode:
description: 'Modo do perfil: discover ou ingest.'
enum:
- discover
- ingest
title: Mode
type: string
name:
description: Nome do perfil.
title: Name
type: string
org_id:
anyOf:
- type: string
- type: 'null'
description: >-
Organização proprietária do perfil. Null quando o perfil é
compartilhado em nível da conta.
title: Org Id
post_ingestion_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientações para a fase pós-ingestão, se houver.
title: Post Ingestion Guidance
profile_id:
description: Identificador exclusivo do perfil.
title: Profile Id
type: string
remediation_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientações para a fase de remediação, se houver.
title: Remediation Guidance
report_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientações para a fase de relatório, se houver.
title: Report Guidance
scan_type:
description: Tipo de varredura que o perfil configura.
enum:
- security
- performance
- db-queries
- test-coverage
- dead-code
- code-quality
- telemetry
- accessibility
- general
- migration-docs
title: Scan Type
type: string
threat_model_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientação que descreve o modelo de ameaças, se houver.
title: Threat Model Guidance
triage_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientação para a fase de triagem, se houver.
title: Triage Guidance
validation_guidance:
anyOf:
- type: string
- type: 'null'
description: Orientação para a fase de validação, se houver.
title: Validation Guidance
visibility:
description: >-
Indica se o perfil pertence a uma única organização ou se é
compartilhado em toda a conta.
enum:
- org
- account
title: Visibility
type: string
required:
- profile_id
- name
- description
- visibility
- org_id
- scan_type
- mode
- include_globs
- exclude_globs
- threat_model_guidance
- investigation_guidance
- triage_guidance
- validation_guidance
- report_guidance
- remediation_guidance
- ingestion_source_guidance
- post_ingestion_guidance
- created_at
title: CodeScanProfileDetailResponse
type: object
ProblemDetail:
description: >-
Corpo de erro RFC 9457 application/problem+json da API v3.
detail é mantido do corpo legado {"detail": ...} por
retrocompatibilidade; os
outros membros são aditivos. errors contém falhas de validação em nível
de campo
(apenas 422).
properties:
detail:
anyOf:
- type: string
- type: 'null'
description: Uma explicação legível por humanos específica para esta ocorrência.
title: Detail
errors:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
description: Erros de validação no nível do campo (apenas respostas 422).
title: Errors
instance:
anyOf:
- type: string
- type: 'null'
description: >-
Uma referência de URI (o caminho da requisição) para esta
ocorrência.
title: Instance
status:
description: O código de status HTTP.
title: Status
type: integer
title:
description: Um breve resumo do tipo de problema, legível para humanos.
title: Title
type: string
type:
default: about:blank
description: Uma referência de URI que identifica o tipo de problema.
title: Type
type: string
required:
- title
- status
title: ProblemDetail
type: object
securitySchemes:
bearerAuth:
description: 'Credencial de usuário de serviço (prefixo: cog_)'
scheme: bearer
type: http
````