Class: Google::Apis::ServiceusageV1::AuthenticationRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/serviceusage_v1/classes.rb,
lib/google/apis/serviceusage_v1/representations.rb,
lib/google/apis/serviceusage_v1/representations.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 Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AuthenticationRule

Returns a new instance of AuthenticationRule.



349
350
351
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 349

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_without_credential ⇒ Boolean Also known as: allow_without_credential?

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

Returns:

  • (Boolean) 


318
319
320
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 318

def allow_without_credential
  @allow_without_credential
end

#oauth ⇒ Google::Apis::ServiceusageV1::OAuthRequirements

OAuth scopes are a way to define data and permissions on data. For example, there are scopes defined for "Read-only access to Google Calendar" and "Access to Cloud Platform". Users can consent to a scope for an application, giving it permission to access that data on their behalf. OAuth scope specifications should be fairly coarse grained; a user will need to see and understand the text description of what your scope means. In most cases: use one or at most two OAuth scopes for an entire family of products. If your product has multiple APIs, you should probably be sharing the OAuth scope across all of those APIs. When you need finer grained OAuth consent screens: talk with your product management about how developers will use them in practice. Please note that even though each of the canonical scopes is enough for a request to be accepted and passed to the backend, a request can still fail due to the backend requiring additional scopes or permissions. Corresponds to the JSON property oauth

Returns:



336
337
338
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 336

def oauth
  @oauth
end

#requirements ⇒ Array<Google::Apis::ServiceusageV1::AuthRequirement>

Requirements for additional authentication providers. Corresponds to the JSON property requirements

Returns:



341
342
343
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 341

def requirements
  @requirements
end

#selector ⇒ String

Selects the methods to which this rule applies. Refer to selector for syntax details. Corresponds to the JSON property selector

Returns:

  • (String) 


347
348
349
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 347

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



354
355
356
357
358
359
 
# File 'lib/google/apis/serviceusage_v1/classes.rb', line 354

def update!(**args)
  @allow_without_credential = args[:allow_without_credential] if args.key?(:allow_without_credential)
  @oauth = args[:oauth] if args.key?(:oauth)
  @requirements = args[:requirements] if args.key?(:requirements)
  @selector = args[:selector] if args.key?(:selector)
end