Class: Google::Apis::ServiceusageV1::AuthRequirement

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/representations.rb

Overview

User-defined authentication requirements, including support for JSON Web Token (JWT).

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AuthRequirement

Returns a new instance of AuthRequirement.


265
266
267
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 265

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

Instance Attribute Details

#audiencesString

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, only JWTs with audience "https:// Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1. LibraryService". Example: audiences: bookstore_android.apps.googleusercontent. com, bookstore_web.apps.googleusercontent.com Corresponds to the JSON property audiences

Returns:

  • (String)

258
259
260
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 258

def audiences
  @audiences
end

#provider_idString

id from authentication provider. Example: provider_id: bookstore_auth Corresponds to the JSON property providerId

Returns:

  • (String)

263
264
265
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 263

def provider_id
  @provider_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


270
271
272
273
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 270

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