Class: A2A::OAuth2SecurityScheme

Inherits:

SecuritySchemeBase

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

Defined in:

lib/a2a/types/oauth2_security_scheme.rb

Overview

Defines a security scheme using OAuth 2.0.

Instance Method Summary

• #flows ⇒ OAuthFlows

  An object containing configuration information for the supported OAuth 2.0 flows.

• #oauth2_metadata_url ⇒ URI^?

  URL to the oauth2 authorization server metadata RFC8414.

• #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

#flows ⇒ OAuthFlows

Returns An object containing configuration information for the supported OAuth 2.0 flows.

Returns:

• (OAuthFlows) —

  An object containing configuration information for the supported OAuth 2.0 flows.

# File 'lib/a2a/types/oauth2_security_scheme.rb', line 10

attribute :flows, Types::Constructor(OAuthFlows)

#oauth2_metadata_url ⇒ URI^?

Returns URL to the oauth2 authorization server metadata RFC8414. TLS is required.

Returns:

• (URI, nil) —

  URL to the oauth2 authorization server metadata RFC8414. TLS is required.

# File 'lib/a2a/types/oauth2_security_scheme.rb', line 14

attribute? :oauth2_metadata_url, Types::URI.optional

#type ⇒ String

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

Returns:

• (String) —

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

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

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