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.



3135
3136
3137
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3135

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) 


3113
3114
3115
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3113

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:



3118
3119
3120
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3118

def key_data
  @key_data
end

#name ⇒ String

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

Returns:

  • (String) 


3123
3124
3125
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3123

def name
  @name
end

#state ⇒ String

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

Returns:

  • (String) 


3128
3129
3130
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3128

def state
  @state
end

#use ⇒ String

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

Returns:

  • (String) 


3133
3134
3135
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3133

def use
  @use
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3140
3141
3142
3143
3144
3145
3146
 
# File 'lib/google/apis/iam_v1/classes.rb', line 3140

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