Class: Akeyless::AuthMethodCreateUniversalIdentity
- Inherits:
-
Object
- Object
- Akeyless::AuthMethodCreateUniversalIdentity
- Defined in:
- lib/akeyless/models/auth_method_create_universal_identity.rb
Overview
authMethodCreateUniversalIdentity is a command that creates a new auth method that will be able to authenticate using Akeyless Universal Identity.
Instance Attribute Summary collapse
-
#access_expires ⇒ Object
Access expiration date in Unix timestamp (select 0 for access without expiry date).
-
#audit_logs_claims ⇒ Object
Subclaims to include in audit logs, e.g "–audit-logs-claims email –audit-logs-claims username".
-
#bound_ips ⇒ Object
A CIDR whitelist with the IPs that the access is restricted to.
-
#delete_protection ⇒ Object
Protection from accidental deletion of this object [true/false].
-
#deny_inheritance ⇒ Object
Deny from root to create children.
-
#deny_rotate ⇒ Object
Deny from the token to rotate.
-
#description ⇒ Object
Auth Method description.
-
#force_sub_claims ⇒ Object
if true: enforce role-association must include sub claims.
-
#gw_bound_ips ⇒ Object
A CIDR whitelist with the GW IPs that the access is restricted to.
-
#json ⇒ Object
Set output format to JSON.
-
#jwt_ttl ⇒ Object
Jwt TTL.
-
#name ⇒ Object
Auth Method name.
-
#product_type ⇒ Object
Choose the relevant product type for the auth method [sm, sra, pm, dp, ca].
-
#token ⇒ Object
Authentication token (see ‘/auth` and `/configure`).
-
#ttl ⇒ Object
Token ttl.
-
#uid_token ⇒ Object
The universal identity token, Required only for universal_identity authentication.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ AuthMethodCreateUniversalIdentity
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ AuthMethodCreateUniversalIdentity
Initializes the object
124 125 126 127 128 129 130 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 160 161 162 163 164 165 166 167 168 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 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 124 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::AuthMethodCreateUniversalIdentity` 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::AuthMethodCreateUniversalIdentity`. 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?(:'access_expires') self.access_expires = attributes[:'access_expires'] else self.access_expires = 0 end if attributes.key?(:'audit_logs_claims') if (value = attributes[:'audit_logs_claims']).is_a?(Array) self.audit_logs_claims = value end end if attributes.key?(:'bound_ips') if (value = attributes[:'bound_ips']).is_a?(Array) self.bound_ips = value end end if attributes.key?(:'delete_protection') self.delete_protection = attributes[:'delete_protection'] end if attributes.key?(:'deny_inheritance') self.deny_inheritance = attributes[:'deny_inheritance'] end if attributes.key?(:'deny_rotate') self.deny_rotate = attributes[:'deny_rotate'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'force_sub_claims') self.force_sub_claims = attributes[:'force_sub_claims'] end if attributes.key?(:'gw_bound_ips') if (value = attributes[:'gw_bound_ips']).is_a?(Array) self.gw_bound_ips = value end end if attributes.key?(:'json') self.json = attributes[:'json'] else self.json = false end if attributes.key?(:'jwt_ttl') self.jwt_ttl = attributes[:'jwt_ttl'] else self.jwt_ttl = 0 end if attributes.key?(:'name') self.name = attributes[:'name'] else self.name = nil end if attributes.key?(:'product_type') if (value = attributes[:'product_type']).is_a?(Array) self.product_type = value end end if attributes.key?(:'token') self.token = attributes[:'token'] end if attributes.key?(:'ttl') self.ttl = attributes[:'ttl'] else self.ttl = 60 end if attributes.key?(:'uid_token') self.uid_token = attributes[:'uid_token'] end end |
Instance Attribute Details
#access_expires ⇒ Object
Access expiration date in Unix timestamp (select 0 for access without expiry date)
20 21 22 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 20 def access_expires @access_expires end |
#audit_logs_claims ⇒ Object
Subclaims to include in audit logs, e.g "–audit-logs-claims email –audit-logs-claims username"
23 24 25 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 23 def audit_logs_claims @audit_logs_claims end |
#bound_ips ⇒ Object
A CIDR whitelist with the IPs that the access is restricted to
26 27 28 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 26 def bound_ips @bound_ips end |
#delete_protection ⇒ Object
Protection from accidental deletion of this object [true/false]
29 30 31 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 29 def delete_protection @delete_protection end |
#deny_inheritance ⇒ Object
Deny from root to create children
32 33 34 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 32 def deny_inheritance @deny_inheritance end |
#deny_rotate ⇒ Object
Deny from the token to rotate
35 36 37 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 35 def deny_rotate @deny_rotate end |
#description ⇒ Object
Auth Method description
38 39 40 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 38 def description @description end |
#force_sub_claims ⇒ Object
if true: enforce role-association must include sub claims
41 42 43 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 41 def force_sub_claims @force_sub_claims end |
#gw_bound_ips ⇒ Object
A CIDR whitelist with the GW IPs that the access is restricted to
44 45 46 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 44 def gw_bound_ips @gw_bound_ips end |
#json ⇒ Object
Set output format to JSON
47 48 49 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 47 def json @json end |
#jwt_ttl ⇒ Object
Jwt TTL
50 51 52 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 50 def jwt_ttl @jwt_ttl end |
#name ⇒ Object
Auth Method name
53 54 55 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 53 def name @name end |
#product_type ⇒ Object
Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
56 57 58 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 56 def product_type @product_type end |
#token ⇒ Object
Authentication token (see ‘/auth` and `/configure`)
59 60 61 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 59 def token @token end |
#ttl ⇒ Object
Token ttl
62 63 64 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 62 def ttl @ttl end |
#uid_token ⇒ Object
The universal identity token, Required only for universal_identity authentication
65 66 67 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 65 def uid_token @uid_token end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 302 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
90 91 92 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 90 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 68 def self.attribute_map { :'access_expires' => :'access-expires', :'audit_logs_claims' => :'audit-logs-claims', :'bound_ips' => :'bound-ips', :'delete_protection' => :'delete_protection', :'deny_inheritance' => :'deny-inheritance', :'deny_rotate' => :'deny-rotate', :'description' => :'description', :'force_sub_claims' => :'force-sub-claims', :'gw_bound_ips' => :'gw-bound-ips', :'json' => :'json', :'jwt_ttl' => :'jwt-ttl', :'name' => :'name', :'product_type' => :'product-type', :'token' => :'token', :'ttl' => :'ttl', :'uid_token' => :'uid-token' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 278 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
117 118 119 120 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 117 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 95 def self.openapi_types { :'access_expires' => :'Integer', :'audit_logs_claims' => :'Array<String>', :'bound_ips' => :'Array<String>', :'delete_protection' => :'String', :'deny_inheritance' => :'Boolean', :'deny_rotate' => :'Boolean', :'description' => :'String', :'force_sub_claims' => :'Boolean', :'gw_bound_ips' => :'Array<String>', :'json' => :'Boolean', :'jwt_ttl' => :'Integer', :'name' => :'String', :'product_type' => :'Array<String>', :'token' => :'String', :'ttl' => :'Integer', :'uid_token' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 242 def ==(o) return true if self.equal?(o) self.class == o.class && access_expires == o.access_expires && audit_logs_claims == o.audit_logs_claims && bound_ips == o.bound_ips && delete_protection == o.delete_protection && deny_inheritance == o.deny_inheritance && deny_rotate == o.deny_rotate && description == o.description && force_sub_claims == o.force_sub_claims && gw_bound_ips == o.gw_bound_ips && json == o.json && jwt_ttl == o.jwt_ttl && name == o.name && product_type == o.product_type && token == o.token && ttl == o.ttl && uid_token == o.uid_token end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 373 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
265 266 267 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 265 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
271 272 273 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 271 def hash [access_expires, audit_logs_claims, bound_ips, delete_protection, deny_inheritance, deny_rotate, description, force_sub_claims, gw_bound_ips, json, jwt_ttl, name, product_type, token, ttl, uid_token].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
222 223 224 225 226 227 228 229 230 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 222 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)
349 350 351 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 349 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
355 356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 355 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
343 344 345 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 343 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
234 235 236 237 238 |
# File 'lib/akeyless/models/auth_method_create_universal_identity.rb', line 234 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @name.nil? true end |