> ## 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.
# Code Scan スキャンプロファイル を取得（Devin API）
> v3 Enterprise API を使用して、モード、スキャンタイプ、包含・除外 glob、ガイダンスを含む Devin の Code Scan スキャンプロファイル を1件取得します
## 権限
Enterprise レベルで `ViewAccountCodeScans` 権限を持つ[サービスユーザー](/ja/api-reference/v3/service-users/members-service-users)または[パーソナルアクセストークン](/ja/api-reference/personal-access-tokens)が必要です。
## 動作
スキャンプロファイルのメタデータ、可視性 (組織所有またはアカウント全体で共有) 、包含/除外グロブ、すべてのガイダンスフィールド (調査、コミュニケーション、取り込みソースに関するガイダンス) を返します。
スキャンプロファイルが存在しない場合、またはEnterpriseアカウントから参照できない場合は、`404`を返します。組織スコープでの同等のエンドポイントについては、[Get Code Scan スキャンプロファイル (Organization)](/ja/api-reference/v3/code-scans/organizations-code-scans-profile)を参照してください。
## OpenAPI
````yaml ja/v3-openapi.yaml GET /v3/enterprise/code-scans/profiles/{profile_id}
openapi: 3.1.0
info:
description: Service User 認証および RBAC に対応した Devin v3 API
title: Devin API v3
version: 3.0.0
servers: []
security:
- bearerAuth: []
paths:
/v3/enterprise/code-scans/profiles/{profile_id}:
get:
tags:
- code-scans
summary: コードスキャンプロファイルを取得
description: >-
IDでコードスキャンプロファイルを取得します。
プロファイルのメタデータ、可視性（組織所有またはアカウント全体で共有）、およびすべてのガイダンス項目を返します。プロファイルが存在しない場合、またはEnterpriseアカウントから表示できない場合は
``404`` を返します。
operationId: >-
handle_get_code_scan_profile_v3_enterprise_code_scans_profiles__profile_id__get
parameters:
- in: path
name: profile_id
required: true
schema:
title: Profile Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CodeScanProfileDetailResponse'
description: 成功レスポンス
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: 未認証
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: アクセス禁止
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: 見つかりません
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: 競合
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: 処理できないコンテンツ
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetail'
description: リクエストが多すぎます
components:
schemas:
CodeScanProfileDetailResponse:
description: ガイダンスを含むコードスキャンプロファイルの詳細情報。
properties:
communication_guidance:
anyOf:
- type: string
- type: 'null'
description: '通信フェーズ（最終的な検出結果への対応。例: 所有者または関係者への通知）に関するガイダンス（該当する場合）。'
title: Communication Guidance
created_at:
description: プロファイルが作成された日時（Unix 秒）。
title: Created At
type: integer
description:
anyOf:
- type: string
- type: 'null'
description: プロファイルの説明（ある場合）。
title: Description
exclude_globs:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: スキャンから除外するファイルの glob パターン（ある場合）。
title: Exclude Globs
include_globs:
anyOf:
- items:
type: string
type: array
- type: 'null'
description: スキャンに含めるファイルの glob パターン（ある場合）。
title: Include Globs
ingestion_source_guidance:
anyOf:
- type: string
- type: 'null'
description: 取り込みソースを説明するガイダンス（ある場合）。
title: Ingestion Source Guidance
investigation_guidance:
anyOf:
- type: string
- type: 'null'
description: 調査フェーズのガイダンス（ある場合）。
title: Investigation Guidance
mode:
description: 'プロファイルモード: discover または ingest。'
enum:
- discover
- ingest
title: Mode
type: string
name:
description: プロファイル名。
title: Name
type: string
org_id:
anyOf:
- type: string
- type: 'null'
description: プロファイルを所有する組織。プロファイルがアカウント全体で共有されている場合は null。
title: Org Id
post_ingestion_guidance:
anyOf:
- type: string
- type: 'null'
description: 取り込み後フェーズのガイダンス（ある場合）。
title: Post Ingestion Guidance
profile_id:
description: プロファイルの一意の識別子。
title: Profile Id
type: string
remediation_guidance:
anyOf:
- type: string
- type: 'null'
description: 修復フェーズのガイダンス（ある場合）。
title: Remediation Guidance
report_guidance:
anyOf:
- type: string
- type: 'null'
description: レポートフェーズのガイダンス（ある場合）。
title: Report Guidance
scan_type:
description: プロファイルが設定するスキャンの種類。
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: 脅威モデルに関するガイダンス（ある場合）。
title: Threat Model Guidance
triage_guidance:
anyOf:
- type: string
- type: 'null'
description: トリアージ段階に関するガイダンス（ある場合）。
title: Triage Guidance
validation_guidance:
anyOf:
- type: string
- type: 'null'
description: 検証段階に関するガイダンス（ある場合）。
title: Validation Guidance
visibility:
description: このプロファイルが単一の組織に属するか、アカウント全体で共有されるかどうか。
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: >-
v3 API 用の RFC 9457 application/problem+json エラーボディ。
detail は後方互換性のため、レガシーな {"detail": ...}
ボディから引き継がれます。その他のメンバーは追加式です。errors にはフィールドレベルのバリデーションエラーが含まれます（422
の場合のみ）。
properties:
detail:
anyOf:
- type: string
- type: 'null'
description: この事象に固有の、人が読める説明。
title: Detail
errors:
anyOf:
- items:
additionalProperties: true
type: object
type: array
- type: 'null'
description: フィールド単位のバリデーションエラー（422 レスポンスのみ）。
title: Errors
instance:
anyOf:
- type: string
- type: 'null'
description: この発生箇所の URI 参照（リクエストパス）。
title: Instance
status:
description: HTTP ステータスコード。
title: Status
type: integer
title:
description: 問題タイプを人が読める短い要約。
title: Title
type: string
type:
default: about:blank
description: 問題タイプを識別する URI 参照。
title: Type
type: string
required:
- title
- status
title: ProblemDetail
type: object
securitySchemes:
bearerAuth:
description: 'サービスユーザーの認証情報（接頭辞: cog_）'
scheme: bearer
type: http
````