Class: Google::Apis::IamV1::WorkforcePoolProviderKey

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

Overview

Represents a public key configuration for a Workforce Pool Provider. The key can be configured in your identity provider to encrypt SAML assertions. Google holds the corresponding private key, which it uses to decrypt encrypted tokens.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WorkforcePoolProviderKey

Returns a new instance of WorkforcePoolProviderKey.



2682
2683
2684
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2682

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

Instance Attribute Details

#expire_time ⇒ String

Output only. The time after which the key will be permanently deleted and cannot be recovered. Note that the key may get purged before this time if the total limit of keys per provider is exceeded. Corresponds to the JSON property expireTime

Returns:

  • (String) 


2660
2661
2662
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2660

def expire_time
  @expire_time
end

#key_data ⇒ Google::Apis::IamV1::KeyData

Represents a public key data along with its format. Corresponds to the JSON property keyData

Returns:



2665
2666
2667
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2665

def key_data
  @key_data
end

#name ⇒ String

Output only. The resource name of the key. Corresponds to the JSON property name

Returns:

  • (String) 


2670
2671
2672
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2670

def name
  @name
end

#state ⇒ String

Output only. The state of the key. Corresponds to the JSON property state

Returns:

  • (String) 


2675
2676
2677
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2675

def state
  @state
end

#use ⇒ String

Required. The purpose of the key. Corresponds to the JSON property use

Returns:

  • (String) 


2680
2681
2682
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2680

def use
  @use
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2687
2688
2689
2690
2691
2692
2693
 
# File 'lib/google/apis/iam_v1/classes.rb', line 2687

def update!(**args)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @key_data = args[:key_data] if args.key?(:key_data)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @use = args[:use] if args.key?(:use)
end