Class: Google::Api::AuthenticationRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/auth.rb

Overview

Authentication rules for the service.

By default, if a method has any authentication requirements, every request must include a valid credential matching one of the requirements. It's an error to include more than one kind of credential in a single request.

If a method doesn't have any auth requirements, request credentials will be ignored.

Instance Attribute Summary collapse

Instance Attribute Details

#allow_without_credential ⇒ ::Boolean

Returns If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.

Returns:

  • (::Boolean) —

    If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests.



78
79
80
81
 
# File 'proto_docs/google/api/auth.rb', line 78

class AuthenticationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#oauth ⇒ ::Google::Api::OAuthRequirements

Returns The requirements for OAuth credentials.

Returns:



78
79
80
81
 
# File 'proto_docs/google/api/auth.rb', line 78

class AuthenticationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#requirements ⇒ ::Array<::Google::Api::AuthRequirement>

Returns Requirements for additional authentication providers.

Returns:



78
79
80
81
 
# File 'proto_docs/google/api/auth.rb', line 78

class AuthenticationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#selector ⇒ ::String

Returns Selects the methods to which this rule applies.

Refer to selector for syntax details.

Returns:

  • (::String) —

    Selects the methods to which this rule applies.

    Refer to selector for syntax details.



78
79
80
81
 
# File 'proto_docs/google/api/auth.rb', line 78

class AuthenticationRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end