Interface SecurityScheme

All Known Implementing Classes:

APIKeySecurityScheme, HTTPAuthSecurityScheme, MutualTLSSecurityScheme, OAuth2SecurityScheme, OpenIdConnectSecurityScheme

public sealed interface SecurityScheme
permits APIKeySecurityScheme, HTTPAuthSecurityScheme, OAuth2SecurityScheme, OpenIdConnectSecurityScheme, MutualTLSSecurityScheme

Base interface for security schemes used to authenticate access to agent endpoints.

This sealed interface defines a discriminated union of authentication mechanisms based on the OpenAPI 3.0 Security Scheme Object specification. Each implementation represents a different authentication strategy that can be declared in an AgentCard.

Supported security schemes:

• APIKeySecurityScheme - API key in header, query, or cookie
• HTTPAuthSecurityScheme - HTTP Basic or Bearer authentication
• OAuth2SecurityScheme - OAuth 2.0 flows
• OpenIdConnectSecurityScheme - OpenID Connect discovery
• MutualTLSSecurityScheme - Client certificate authentication

See Also:

• for security scheme declarations
• OpenAPI Security Scheme Object
• A2A Protocol Specification

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the human-readable description of this security scheme.
String	type()	Returns the type of the security scheme.

Method Details

description

String description()

Returns the human-readable description of this security scheme.

Returns:

the description, or null if not provided

type

String type()

Returns the type of the security scheme.

Returns:

the type of the security scheme.