Class: Akeyless::GatewayCreateProducerPing

Inherits:
Object
  • Object
show all
Defined in:
lib/akeyless/models/gateway_create_producer_ping.rb

Overview

gatewayCreateProducerPing is a command that creates ping producer [Deprecated: Use dynamic-secret-create-ping command]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateProducerPing

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 169

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayCreateProducerPing` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::GatewayCreateProducerPing`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'delete_protection')
    self.delete_protection = attributes[:'delete_protection']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'ping_administrative_port')
    self.ping_administrative_port = attributes[:'ping_administrative_port']
  else
    self.ping_administrative_port = '9999'
  end

  if attributes.key?(:'ping_atm_id')
    self.ping_atm_id = attributes[:'ping_atm_id']
  end

  if attributes.key?(:'ping_authorization_port')
    self.ping_authorization_port = attributes[:'ping_authorization_port']
  else
    self.ping_authorization_port = '9031'
  end

  if attributes.key?(:'ping_cert_subject_dn')
    self.ping_cert_subject_dn = attributes[:'ping_cert_subject_dn']
  end

  if attributes.key?(:'ping_client_authentication_type')
    self.ping_client_authentication_type = attributes[:'ping_client_authentication_type']
  else
    self.ping_client_authentication_type = 'CLIENT_SECRET'
  end

  if attributes.key?(:'ping_enforce_replay_prevention')
    self.ping_enforce_replay_prevention = attributes[:'ping_enforce_replay_prevention']
  else
    self.ping_enforce_replay_prevention = 'false'
  end

  if attributes.key?(:'ping_grant_types')
    if (value = attributes[:'ping_grant_types']).is_a?(Array)
      self.ping_grant_types = value
    end
  end

  if attributes.key?(:'ping_issuer_dn')
    self.ping_issuer_dn = attributes[:'ping_issuer_dn']
  end

  if attributes.key?(:'ping_jwks')
    self.ping_jwks = attributes[:'ping_jwks']
  end

  if attributes.key?(:'ping_jwks_url')
    self.ping_jwks_url = attributes[:'ping_jwks_url']
  end

  if attributes.key?(:'ping_password')
    self.ping_password = attributes[:'ping_password']
  end

  if attributes.key?(:'ping_privileged_user')
    self.ping_privileged_user = attributes[:'ping_privileged_user']
  end

  if attributes.key?(:'ping_redirect_uris')
    if (value = attributes[:'ping_redirect_uris']).is_a?(Array)
      self.ping_redirect_uris = value
    end
  end

  if attributes.key?(:'ping_restricted_scopes')
    if (value = attributes[:'ping_restricted_scopes']).is_a?(Array)
      self.ping_restricted_scopes = value
    end
  end

  if attributes.key?(:'ping_signing_algo')
    self.ping_signing_algo = attributes[:'ping_signing_algo']
  end

  if attributes.key?(:'ping_url')
    self.ping_url = attributes[:'ping_url']
  end

  if attributes.key?(:'producer_encryption_key_name')
    self.producer_encryption_key_name = attributes[:'producer_encryption_key_name']
  end

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'target_name')
    self.target_name = attributes[:'target_name']
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end

  if attributes.key?(:'user_ttl')
    self.user_ttl = attributes[:'user_ttl']
  else
    self.user_ttl = '60m'
  end
end

Instance Attribute Details

#delete_protection ⇒ Object

Protection from accidental deletion of this object [true/false]



20
21
22
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 20

def delete_protection
  @delete_protection
end

#json ⇒ Object

Set output format to JSON



23
24
25
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 23

def json
  @json
end

#name ⇒ Object

Dynamic secret name



26
27
28
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 26

def name
  @name
end

#ping_administrative_port ⇒ Object

Ping Federate administrative port



29
30
31
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 29

def ping_administrative_port
  @ping_administrative_port
end

#ping_atm_id ⇒ Object

Set a specific Access Token Management (ATM) instance for the created OAuth Client by providing the ATM Id. If no explicit value is given, the default pingfederate server ATM will be set.



32
33
34
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 32

def ping_atm_id
  @ping_atm_id
end

#ping_authorization_port ⇒ Object

Ping Federate authorization port



35
36
37
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 35

def ping_authorization_port
  @ping_authorization_port
end

#ping_cert_subject_dn ⇒ Object

The subject DN of the client certificate. If no explicit value is given, the producer will create CA certificate and matched client certificate and return it as value. Used in conjunction with ping-issuer-dn (relevant for CLIENT_TLS_CERTIFICATE authentication method)



38
39
40
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 38

def ping_cert_subject_dn
  @ping_cert_subject_dn
end

#ping_client_authentication_type ⇒ Object

OAuth Client Authentication Type [CLIENT_SECRET, PRIVATE_KEY_JWT, CLIENT_TLS_CERTIFICATE]



41
42
43
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 41

def ping_client_authentication_type
  @ping_client_authentication_type
end

#ping_enforce_replay_prevention ⇒ Object

Determines whether PingFederate requires a unique signed JWT from the client for each action (relevant for PRIVATE_KEY_JWT authentication method) [true/false]



44
45
46
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 44

def ping_enforce_replay_prevention
  @ping_enforce_replay_prevention
end

#ping_grant_types ⇒ Object

List of OAuth client grant types [IMPLICIT, AUTHORIZATION_CODE, CLIENT_CREDENTIALS, TOKEN_EXCHANGE, REFRESH_TOKEN, ASSERTION_GRANTS, PASSWORD, RESOURCE_OWNER_CREDENTIALS]. If no explicit value is given, AUTHORIZATION_CODE will be selected as default.



47
48
49
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 47

def ping_grant_types
  @ping_grant_types
end

#ping_issuer_dn ⇒ Object

Issuer DN of trusted CA certificate that imported into Ping Federate server. You may select \"Trust Any\" to trust all the existing issuers in Ping Federate server. Used in conjunction with ping-cert-subject-dn (relevant for CLIENT_TLS_CERTIFICATE authentication method)



50
51
52
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 50

def ping_issuer_dn
  @ping_issuer_dn
end

#ping_jwks ⇒ Object

Base64-encoded JSON Web Key Set (JWKS). If no explicit value is given, the producer will create JWKs and matched signed JWT (Sign Algo: RS256) and return it as value (relevant for PRIVATE_KEY_JWT authentication method)



53
54
55
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 53

def ping_jwks
  @ping_jwks
end

#ping_jwks_url ⇒ Object

The URL of the JSON Web Key Set (JWKS). If no explicit value is given, the producer will create JWKs and matched signed JWT and return it as value (relevant for PRIVATE_KEY_JWT authentication method)



56
57
58
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 56

def ping_jwks_url
  @ping_jwks_url
end

#ping_password ⇒ Object

Ping Federate privileged user password



59
60
61
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 59

def ping_password
  @ping_password
end

#ping_privileged_user ⇒ Object

Ping Federate privileged user



62
63
64
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 62

def ping_privileged_user
  @ping_privileged_user
end

#ping_redirect_uris ⇒ Object

List of URIs to which the OAuth authorization server may redirect the resource owner’s user agent after authorization is obtained. At least one redirection URI is required for the AUTHORIZATION_CODE and IMPLICIT grant types.



65
66
67
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 65

def ping_redirect_uris
  @ping_redirect_uris
end

#ping_restricted_scopes ⇒ Object

Limit the OAuth client to specific scopes list



68
69
70
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 68

def ping_restricted_scopes
  @ping_restricted_scopes
end

#ping_signing_algo ⇒ Object

The signing algorithm that the client must use to sign its request objects [RS256,RS384,RS512,ES256,ES384,ES512,PS256,PS384,PS512] If no explicit value is given, the client can use any of the supported signing algorithms (relevant for PRIVATE_KEY_JWT authentication method)



71
72
73
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 71

def ping_signing_algo
  @ping_signing_algo
end

#ping_url ⇒ Object

Ping URL



74
75
76
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 74

def ping_url
  @ping_url
end

#producer_encryption_key_name ⇒ Object

Dynamic producer encryption key



77
78
79
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 77

def producer_encryption_key_name
  @producer_encryption_key_name
end

#tags ⇒ Object

Add tags attached to this object



80
81
82
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 80

def tags
  @tags
end

#target_name ⇒ Object

Target name



83
84
85
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 83

def target_name
  @target_name
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



86
87
88
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 86

def token
  @token
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



89
90
91
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 89

def uid_token
  @uid_token
end

#user_ttl ⇒ Object

The time from dynamic secret creation to expiration.



92
93
94
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 92

def user_ttl
  @user_ttl
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 396

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 95

def self.attribute_map
  {
    :'delete_protection' => :'delete_protection',
    :'json' => :'json',
    :'name' => :'name',
    :'ping_administrative_port' => :'ping-administrative-port',
    :'ping_atm_id' => :'ping-atm-id',
    :'ping_authorization_port' => :'ping-authorization-port',
    :'ping_cert_subject_dn' => :'ping-cert-subject-dn',
    :'ping_client_authentication_type' => :'ping-client-authentication-type',
    :'ping_enforce_replay_prevention' => :'ping-enforce-replay-prevention',
    :'ping_grant_types' => :'ping-grant-types',
    :'ping_issuer_dn' => :'ping-issuer-dn',
    :'ping_jwks' => :'ping-jwks',
    :'ping_jwks_url' => :'ping-jwks-url',
    :'ping_password' => :'ping-password',
    :'ping_privileged_user' => :'ping-privileged-user',
    :'ping_redirect_uris' => :'ping-redirect-uris',
    :'ping_restricted_scopes' => :'ping-restricted-scopes',
    :'ping_signing_algo' => :'ping-signing-algo',
    :'ping_url' => :'ping-url',
    :'producer_encryption_key_name' => :'producer-encryption-key-name',
    :'tags' => :'tags',
    :'target_name' => :'target-name',
    :'token' => :'token',
    :'uid_token' => :'uid-token',
    :'user_ttl' => :'user-ttl'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 372

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



162
163
164
165
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 162

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 131

def self.openapi_types
  {
    :'delete_protection' => :'String',
    :'json' => :'Boolean',
    :'name' => :'String',
    :'ping_administrative_port' => :'String',
    :'ping_atm_id' => :'String',
    :'ping_authorization_port' => :'String',
    :'ping_cert_subject_dn' => :'String',
    :'ping_client_authentication_type' => :'String',
    :'ping_enforce_replay_prevention' => :'String',
    :'ping_grant_types' => :'Array<String>',
    :'ping_issuer_dn' => :'String',
    :'ping_jwks' => :'String',
    :'ping_jwks_url' => :'String',
    :'ping_password' => :'String',
    :'ping_privileged_user' => :'String',
    :'ping_redirect_uris' => :'Array<String>',
    :'ping_restricted_scopes' => :'Array<String>',
    :'ping_signing_algo' => :'String',
    :'ping_url' => :'String',
    :'producer_encryption_key_name' => :'String',
    :'tags' => :'Array<String>',
    :'target_name' => :'String',
    :'token' => :'String',
    :'uid_token' => :'String',
    :'user_ttl' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 327

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      delete_protection == o.delete_protection &&
      json == o.json &&
      name == o.name &&
      ping_administrative_port == o.ping_administrative_port &&
      ping_atm_id == o.ping_atm_id &&
      ping_authorization_port == o.ping_authorization_port &&
      ping_cert_subject_dn == o.ping_cert_subject_dn &&
      ping_client_authentication_type == o.ping_client_authentication_type &&
      ping_enforce_replay_prevention == o.ping_enforce_replay_prevention &&
      ping_grant_types == o.ping_grant_types &&
      ping_issuer_dn == o.ping_issuer_dn &&
      ping_jwks == o.ping_jwks &&
      ping_jwks_url == o.ping_jwks_url &&
      ping_password == o.ping_password &&
      ping_privileged_user == o.ping_privileged_user &&
      ping_redirect_uris == o.ping_redirect_uris &&
      ping_restricted_scopes == o.ping_restricted_scopes &&
      ping_signing_algo == o.ping_signing_algo &&
      ping_url == o.ping_url &&
      producer_encryption_key_name == o.producer_encryption_key_name &&
      tags == o.tags &&
      target_name == o.target_name &&
      token == o.token &&
      uid_token == o.uid_token &&
      user_ttl == o.user_ttl
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 467

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


359
360
361
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



365
366
367
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 365

def hash
  [delete_protection, json, name, ping_administrative_port, ping_atm_id, ping_authorization_port, ping_cert_subject_dn, ping_client_authentication_type, ping_enforce_replay_prevention, ping_grant_types, ping_issuer_dn, ping_jwks, ping_jwks_url, ping_password, ping_privileged_user, ping_redirect_uris, ping_restricted_scopes, ping_signing_algo, ping_url, producer_encryption_key_name, tags, target_name, token, uid_token, user_ttl].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



307
308
309
310
311
312
313
314
315
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 307

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



443
444
445
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 443

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 449

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



437
438
439
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 437

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



319
320
321
322
323
 
# File 'lib/akeyless/models/gateway_create_producer_ping.rb', line 319

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  true
end