Class: Google::Apis::ServicenetworkingV1::OAuthRequirements

Inherits:

Object

• Object
• Google::Apis::ServicenetworkingV1::OAuthRequirements

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/servicenetworking_v1/classes.rb,
lib/google/apis/servicenetworking_v1/representations.rb,
lib/google/apis/servicenetworking_v1/representations.rb

Overview

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.

Instance Attribute Summary

• #allow_any_scope ⇒ Boolean (also: #allow_any_scope?)

  UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope.

• #canonical_scopes ⇒ String

  The list of publicly documented OAuth scopes that are allowed access.

Instance Method Summary

• #initialize(**args) ⇒ OAuthRequirements constructor

  A new instance of OAuthRequirements.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ OAuthRequirements

Returns a new instance of OAuthRequirements.

# File 'lib/google/apis/servicenetworking_v1/classes.rb', line 2861

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

Instance Attribute Details

#allow_any_scope ⇒ Boolean Also known as: allow_any_scope?

UNIMPLEMENTED: If enabled, ESF will allow OAuth credentials with any scope, more details in http://go/esf-oauth-any-scope. WARNING: Enabling this option will bring security risks. Customers enabling this feature accidentally may have the risk of losing authentication enforcement. Please reach out to api- auth@ and esf-team@ for approval and allowlisting before you enable this option. Corresponds to the JSON property allowAnyScope

Returns:

• (Boolean)

# File 'lib/google/apis/servicenetworking_v1/classes.rb', line 2850

def allow_any_scope
  @allow_any_scope
end

#canonical_scopes ⇒ String

The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes: https://www.googleapis.com/auth/calendar, https://www. googleapis.com/auth/calendar.read Corresponds to the JSON property canonicalScopes

Returns:

• (String)

# File 'lib/google/apis/servicenetworking_v1/classes.rb', line 2859

def canonical_scopes
  @canonical_scopes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/servicenetworking_v1/classes.rb', line 2866

def update!(**args)
  @allow_any_scope = args[:allow_any_scope] if args.key?(:allow_any_scope)
  @canonical_scopes = args[:canonical_scopes] if args.key?(:canonical_scopes)
end