Class: A2A::AuthorizationCodeOAuthFlow

Inherits:
ProtocolStruct
  • Object
show all
Defined in:
lib/a2a/types/authorization_code_oauth_flow.rb

Overview

Defines configuration details for the OAuth 2.0 Authorization Code flow.

Instance Method Summary collapse

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#authorization_url ⇒ URI

Returns The authorization URL to be used for this flow. This MUST be a URL and use TLS.

Returns:

  • (URI) —

    The authorization URL to be used for this flow. This MUST be a URL and use TLS.



8
 
# File 'lib/a2a/types/authorization_code_oauth_flow.rb', line 8

attribute :authorization_url, Types::URI

#refresh_url ⇒ URI?

Returns The URL to be used for obtaining refresh tokens. This MUST be a URL and use TLS.

Returns:

  • (URI, nil) —

    The URL to be used for obtaining refresh tokens. This MUST be a URL and use TLS.



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

attribute? :refresh_url, Types::URI.optional

#scopes ⇒ Hash

Returns The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.

Returns:

  • (Hash) —

    The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.



20
 
# File 'lib/a2a/types/authorization_code_oauth_flow.rb', line 20

attribute :scopes, Types::Hash.map(Types::String, Types::String)

#token_url ⇒ URI

Returns The token URL to be used for this flow. This MUST be a URL and use TLS.

Returns:

  • (URI) —

    The token URL to be used for this flow. This MUST be a URL and use TLS.



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

attribute :token_url, Types::URI