Class: A2A::HTTPAuthSecurityScheme

Inherits:

SecuritySchemeBase

• Object
• Dry::Struct
• ProtocolStruct
• SecuritySchemeBase
• A2A::HTTPAuthSecurityScheme

Defined in:

lib/a2a/types/http_auth_security_scheme.rb

Overview

Defines a security scheme using HTTP authentication.

Instance Method Summary

• #bearer_format ⇒ String^?

  A hint to the client to identify how the bearer token is formatted (e.g., “JWT”).

• #scheme ⇒ String

  The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., “Bearer”).

• #type ⇒ String

  The type of the security scheme.

Methods inherited from SecuritySchemeBase

#description

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#bearer_format ⇒ String^?

Returns A hint to the client to identify how the bearer token is formatted (e.g., “JWT”). This is primarily for documentation purposes.

Returns:

• (String, nil) —

  A hint to the client to identify how the bearer token is formatted (e.g., “JWT”). This is primarily for documentation purposes.

# File 'lib/a2a/types/http_auth_security_scheme.rb', line 16

attribute? :bearer_format, Types::String.optional

#scheme ⇒ String

Returns The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., “Bearer”). This value should be registered in the IANA Authentication Scheme registry.

Returns:

• (String) —

  The name of the HTTP Authentication scheme to be used in the Authorization header, as defined in RFC7235 (e.g., “Bearer”). This value should be registered in the IANA Authentication Scheme registry.

# File 'lib/a2a/types/http_auth_security_scheme.rb', line 12

attribute :scheme, Types::String

#type ⇒ String

Returns The type of the security scheme. Must be ‘http’.

Returns:

• (String) —

  The type of the security scheme. Must be ‘http’.

# File 'lib/a2a/types/http_auth_security_scheme.rb', line 7

attribute :type, Types::String.constant('http')