The identity and technical contract details declared by the specification.
DatabricksConnectionRedactParams
object
6 properties
3 required
RestConnectionParamsRedactBase
object
8 properties
HeadersAuthConfig
object
Static header injection (API keys, bearer tokens).
1 property
1 required
TargetType
string
Target Types Available
HuggingfaceConnectionRedactParams
object
Connection parameters specific to huggingface targets
2 properties
2 required
BedrockAccessConnectionParams
object
AWS Bedrock access parameters stored in targetmetadata.
5 properties
4 required
MSCopilotStudioAuthUrlResponseSchema
object
Response containing the generated OAuth auth URL.
3 properties
3 required
PaginationSchema
object
1 property
MultiTurnStatelessConfig
object
Configuration for stateless multi-turn targets (sessionsupported=false). Stateless targets require the client to maintain and send conversation history. The as…
2 properties
StreamingConnectionParamsBase-Output
object
Base streaming connection parameters without generated fields.
10 properties
2 required
ResponseMode
string
Response mode for target interactions.
BasicAuthAuthConfigRedact
object
2 properties
HuggingfaceConnectionParams
object
Connection parameters specific to huggingface targets
2 properties
2 required
OpenAIConnectionParams
object
Connection parameters specific to OpenAI targets
2 properties
2 required
AdapterVarBase
object
A single adapter configuration variable (also the GSM-stored shape).
3 properties
2 required
BasicAuthLocation
string
Where Basic Auth credentials are sent.
NativeConnectionParamsBase-Output
object
Base connection parameters for native/SDK-based targets (no HTTP endpoint). Used for no-code agent platforms like Microsoft Copilot Studio where interaction is…
3 properties
MSCopilotStudioTokenRequestSchema
object
Request body for exchanging auth code for tokens (POST /token).
6 properties
5 required
StreamingConnectionParamsRedactBase
object
10 properties
2 required
AiGeneratedLanguageListFieldInfo
object
AI tracking for the languagessupported list field.
4 properties
2 required
TargetCreateRequestSchema
object
Target create request schema for validating and defining target creation parameters.
18 properties
1 required
OAuth2AuthConfigRedact
object
6 properties
2 required
TargetBackground
object
Target background - used in create/update API requests and stored in DB/GCS. Required fields for activation: - industry (string, required) - usecase (string, r…
4 properties
AiGeneratedItems
object
Per-field AI tracking with item-level tags and counts.
7 properties
MSCopilotStudioConnectionRedactParams
object
Redacted version with SecretStr for sensitive fields.
6 properties
5 required
TargetProbeRequest
object
Request to run profiling probes on a target. Inherits all target creation fields (connection params, metadata, etc.) If probefields is None, runs all 9 probes.…
20 properties
1 required
TargetAdditionalContext
object
Additional context - used in create/update API requests and stored in DB/GCS. Single value fields are strings. List fields are lists of strings.
6 properties
AiGeneratedStringFieldInfo
object
AI tracking for a string field (basemodel, corearchitecture, systemprompt).
2 properties
1 required
TargetContextUpdateSchema
object
Request schema for updating target profile (background + additional context). Used by PUT /{targetuuid}/profile endpoint. User provides plain values which are…
2 properties
TargetListSchema
object
Schema returned by API for list target operations.
2 properties
1 required
TargetMetadata
object
Metadata stored in the database for targets (user-provided + computed fields). Inherits the multimodal-capability fields from MultiModalResult and the multi-tu…
15 properties
TargetUpdateRequestSchema
object
Schema for both create and update operations.
18 properties
1 required
NativeConnectionParamsBase-Input
object
Base connection parameters for native/SDK-based targets (no HTTP endpoint). Used for no-code agent platforms like Microsoft Copilot Studio where interaction is…
3 properties
MultiTurnStatefulConfig
object
Configuration for stateful multi-turn targets (sessionsupported=true). Stateful targets maintain conversation state on the server side using session IDs. The s…
3 properties
2 required
TargetSchema
object
Target Get Schema with profiling fields. Inherits from TargetDetailSchema which includes: - targetbackground: industry, usecase, competitors - profilingstatus:…
32 properties
8 required
red_team_shared__schemas__databricks__AuthType
string
TargetStatusFilter
string
Status values accepted by the list-targets status filter. Unions the target status and profiling status values so a single status filter can match on either. A…
TargetAuthValidationResponseSchema
object
Response schema from target authentication validation. On failure, the service raises airscommon exceptions (ValidationError, AuthError, etc.) which are conver…
3 properties
1 required
HeadersAuthConfigRedact
object
1 property
1 required
MSCopilotStudioAuthUrlRequestSchema
object
Request body for generating MS Copilot Studio OAuth auth URL (POST /auth-url). If tokenjsonuuid is provided, reuses existing UUID (re-auth). If omitted, genera…
5 properties
3 required
AiItemTag
object
Single item with AI tracking tag. FE renders directly.
2 properties
2 required
TargetRedactSchema
object
Target redact Schema
32 properties
8 required
BedrockAccessConnectionRedactParams
object
AWS Bedrock access parameters stored in targetmetadata.
5 properties
4 required
AiLanguageItemTag
object
AI tracking tag for language items, includes ISO 639-1 code for flag display.
3 properties
2 required
NativeConnectionParamsRedactBase
object
Redacted version of NativeConnectionParamsBase.
3 properties
OpenAIConnectionRedactParams
object
Connection parameters specific to OpenAI targets
2 properties
2 required
MSCopilotStudioTokenResponseSchema
object
Response after successful token exchange (POST/PUT /token).
1 property
1 required
AiGeneratedListFieldInfo
object
AI tracking for a list field (tools, keywords, competitors).
4 properties
2 required
DatabricksConnectionParams
object
6 properties
3 required
TargetResponseSchema
object
28 properties
8 required
OAuth2AuthConfig
object
OAuth2 client credentials with proactive token refresh.
6 properties
2 required
WebSocketConnectionParamsBase-Output
object
Connection parameters for WebSocket targets.
9 properties
MSCopilotStudioConnectionParams
object
Microsoft Copilot Studio Agent connection parameters.
7 properties
5 required
StreamingConnectionParamsBase-Input
object
Base streaming connection parameters without generated fields.
10 properties
2 required
StartProfilingResponseSchema
object
Response schema for start profiling action.
1 property
1 required
TargetConnectionType
string
Connection type/provider for the target.
ValidationError
object
3 properties
3 required
WebSocketConnectionParamsBase-Input
object
Connection parameters for WebSocket targets.
9 properties
TargetListItemSchema
object
23 properties
8 required
OtherDetails
object
Additional profiler discoveries. Read-only key-value pairs. Examples: codeexecutioncapability, internetaccess, etc.
1 property
TargetProfileResponse
object
Combined response for profile view.
12 properties
3 required
RestConnectionParamsBase-Output
object
Base connection parameters without generated fields.
8 properties
TargetStatus
string
Status enumeration for scan targets.
BasicAuthAuthConfig
object
Basic Auth credentials — header or payload location.
2 properties
HTTPValidationError
object
1 property
AdapterVarResponseSchema
object
A variable returned in adapter responses. Secrets are masked: value is returned as null with isredacted=true.
4 properties
2 required
ProfilingStatus
string
Status of target profiling workflow.
AdapterVarType
string
Whether a configuration variable is a plain var or a sensitive secret.
OtherDetailsPrettified
object
Categorized view of profiler discoveries for FE display.
7 properties
WebSocketConnectionParamsRedactBase
object
Redacted connection parameters for WebSocket targets. MRO: WebSocketConnectionParamsRedactBase → RestConnectionParamsRedactBase → WebSocketConnectionParamsBase…
9 properties
RestConnectionParamsBase-Input
object
Base connection parameters without generated fields.
8 properties
red_team_shared__schemas__auth_config__AuthType
string
Authentication method for target API access.
ApiEndpointType
string
API endpoint accessibility type.
TargetAuthValidationRequestSchema
object
Request schema to validate target authentication configuration.
4 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Palo Alto Networks publishes across the network.
