Class: Google::Apis::StsV1::GoogleIdentityStsV1Options

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

Overview

An Options object configures features that the Security Token Service supports, but that are not supported by standard OAuth 2.0 token exchange endpoints, as defined in https://tools.ietf.org/html/rfc8693.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleIdentityStsV1Options

Returns a new instance of GoogleIdentityStsV1Options.



420
421
422
 
# File 'lib/google/apis/sts_v1/classes.rb', line 420

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

Instance Attribute Details

#access_boundary ⇒ Google::Apis::StsV1::GoogleIdentityStsV1AccessBoundary

An access boundary defines the upper bound of what a principal may access. It includes a list of access boundary rules that each defines the resource that may be allowed as well as permissions that may be used on those resources. Corresponds to the JSON property accessBoundary

Returns:



401
402
403
 
# File 'lib/google/apis/sts_v1/classes.rb', line 401

def access_boundary
  @access_boundary
end

#audiences ⇒ Array<String>

The intended audience(s) of the credential. The audience value(s) should be the name(s) of services intended to receive the credential. Example: ["https:/ /pubsub.googleapis.com/", "https://storage.googleapis.com/"]. A maximum of 5 audiences can be included. For each provided audience, the maximum length is 262 characters. Corresponds to the JSON property audiences

Returns:

  • (Array<String>) 


410
411
412
 
# File 'lib/google/apis/sts_v1/classes.rb', line 410

def audiences
  @audiences
end

#user_project ⇒ String

A Google project used for quota and billing purposes when the credential is used to access Google APIs. The provided project overrides the project bound to the credential. The value must be a project number or a project ID. Example: my-sample-project-191923. The maximum length is 32 characters. Corresponds to the JSON property userProject

Returns:

  • (String) 


418
419
420
 
# File 'lib/google/apis/sts_v1/classes.rb', line 418

def user_project
  @user_project
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



425
426
427
428
429
 
# File 'lib/google/apis/sts_v1/classes.rb', line 425

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