Class: Akeyless::AzureADAccessRules

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

Overview

AzureADAccessRules contains access rules specific to Azure Active Directory authentication.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AzureADAccessRules

Initializes the object

Parameters:

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

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
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
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 109

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::AzureADAccessRules` 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::AzureADAccessRules`. 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?(:'ad_endpoint')
    self.ad_endpoint = attributes[:'ad_endpoint']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ad_endpoint ⇒ Object

The audience in the JWT.



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

def ad_endpoint
  @ad_endpoint
end

#bound_group_ids ⇒ Object

The list of group ids that login is restricted to.



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

def bound_group_ids
  @bound_group_ids
end

#bound_resource_groups ⇒ Object

The list of resource groups that login is restricted to.



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

def bound_resource_groups
  @bound_resource_groups
end

#bound_resource_ids ⇒ Object

The list of full resource ids that the login is restricted to.



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

def bound_resource_ids
  @bound_resource_ids
end

#bound_resource_names ⇒ Object

The list of resource names that the login is restricted to (e.g, a virtual machine name, scale set name, etc).



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

def bound_resource_names
  @bound_resource_names
end

#bound_resource_providers ⇒ Object

The list of resource providers that login is restricted to (e.g, Microsoft.Compute, Microsoft.ManagedIdentity, etc).



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

def bound_resource_providers
  @bound_resource_providers
end

#bound_resource_types ⇒ Object

The list of resource types that login is restricted to (e.g, virtualMachines, userAssignedIdentities, etc).



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

def bound_resource_types
  @bound_resource_types
end

#bound_service_principal_ids ⇒ Object

The list of service principal IDs that login is restricted to.



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

def bound_service_principal_ids
  @bound_service_principal_ids
end

#bound_subscription_ids ⇒ Object

The list of subscription IDs that login is restricted to.



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

def bound_subscription_ids
  @bound_subscription_ids
end

#bound_tenant_id ⇒ Object

The tenants id for the Azure Active Directory organization.



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

def bound_tenant_id
  @bound_tenant_id
end

#issuer ⇒ Object

Issuer URL



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

def issuer
  @issuer
end

#jwks_uri ⇒ Object

The URL to the JSON Web Key Set (JWKS) that containing the public keys that should be used to verify any JSON Web Token (JWT) issued by the authorization server.



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

def jwks_uri
  @jwks_uri
end

#unique_identifier ⇒ Object

A unique identifier to distinguish different users



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

def unique_identifier
  @unique_identifier
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



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
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 265

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



78
79
80
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 78

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 59

def self.attribute_map
  {
    :'ad_endpoint' => :'ad_endpoint',
    :'bound_group_ids' => :'bound_group_ids',
    :'bound_resource_groups' => :'bound_resource_groups',
    :'bound_resource_ids' => :'bound_resource_ids',
    :'bound_resource_names' => :'bound_resource_names',
    :'bound_resource_providers' => :'bound_resource_providers',
    :'bound_resource_types' => :'bound_resource_types',
    :'bound_service_principal_ids' => :'bound_service_principal_ids',
    :'bound_subscription_ids' => :'bound_subscription_ids',
    :'bound_tenant_id' => :'bound_tenant_id',
    :'issuer' => :'issuer',
    :'jwks_uri' => :'jwks_uri',
    :'unique_identifier' => :'unique_identifier'
  }
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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 241

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



102
103
104
105
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 102

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

.openapi_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 83

def self.openapi_types
  {
    :'ad_endpoint' => :'String',
    :'bound_group_ids' => :'Array<String>',
    :'bound_resource_groups' => :'Array<String>',
    :'bound_resource_ids' => :'Array<String>',
    :'bound_resource_names' => :'Array<String>',
    :'bound_resource_providers' => :'Array<String>',
    :'bound_resource_types' => :'Array<String>',
    :'bound_service_principal_ids' => :'Array<String>',
    :'bound_subscription_ids' => :'Array<String>',
    :'bound_tenant_id' => :'String',
    :'issuer' => :'String',
    :'jwks_uri' => :'String',
    :'unique_identifier' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ad_endpoint == o.ad_endpoint &&
      bound_group_ids == o.bound_group_ids &&
      bound_resource_groups == o.bound_resource_groups &&
      bound_resource_ids == o.bound_resource_ids &&
      bound_resource_names == o.bound_resource_names &&
      bound_resource_providers == o.bound_resource_providers &&
      bound_resource_types == o.bound_resource_types &&
      bound_service_principal_ids == o.bound_service_principal_ids &&
      bound_subscription_ids == o.bound_subscription_ids &&
      bound_tenant_id == o.bound_tenant_id &&
      issuer == o.issuer &&
      jwks_uri == o.jwks_uri &&
      unique_identifier == o.unique_identifier
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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 336

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


228
229
230
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 228

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



234
235
236
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 234

def hash
  [ad_endpoint, bound_group_ids, bound_resource_groups, bound_resource_ids, bound_resource_names, bound_resource_providers, bound_resource_types, bound_service_principal_ids, bound_subscription_ids, bound_tenant_id, issuer, jwks_uri, unique_identifier].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



193
194
195
196
197
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 193

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



312
313
314
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 318

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



306
307
308
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 306

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



201
202
203
204
 
# File 'lib/akeyless/models/azure_ad_access_rules.rb', line 201

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end