Class: OCI::IdentityDomains::Models::IdentityProofingProviderTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/identity_proofing_provider_template.rb

Overview

Maintains a registered Collection of Identity Proofing vendors list. This REST API is SCIM compliant.

Constant Summary collapse

IDCS_PREVENTED_OPERATIONS_ENUM = 
[
  IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_PREVENTED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
IDCS_LOCKED_OPERATIONS_ENUM = 
[
  IDCS_LOCKED_OPERATIONS_REPLACE = 'replace'.freeze,
  IDCS_LOCKED_OPERATIONS_UPDATE = 'update'.freeze,
  IDCS_LOCKED_OPERATIONS_DELETE = 'delete'.freeze,
  IDCS_LOCKED_OPERATIONS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityProofingProviderTemplate

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
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
434
435
436
437
438
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 341

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.ocid = attributes[:'ocid'] if attributes[:'ocid']

  self.schemas = attributes[:'schemas'] if attributes[:'schemas']

  self.meta = attributes[:'meta'] if attributes[:'meta']

  self.idcs_created_by = attributes[:'idcsCreatedBy'] if attributes[:'idcsCreatedBy']

  raise 'You cannot provide both :idcsCreatedBy and :idcs_created_by' if attributes.key?(:'idcsCreatedBy') && attributes.key?(:'idcs_created_by')

  self.idcs_created_by = attributes[:'idcs_created_by'] if attributes[:'idcs_created_by']

  self.idcs_last_modified_by = attributes[:'idcsLastModifiedBy'] if attributes[:'idcsLastModifiedBy']

  raise 'You cannot provide both :idcsLastModifiedBy and :idcs_last_modified_by' if attributes.key?(:'idcsLastModifiedBy') && attributes.key?(:'idcs_last_modified_by')

  self.idcs_last_modified_by = attributes[:'idcs_last_modified_by'] if attributes[:'idcs_last_modified_by']

  self.idcs_prevented_operations = attributes[:'idcsPreventedOperations'] if attributes[:'idcsPreventedOperations']

  raise 'You cannot provide both :idcsPreventedOperations and :idcs_prevented_operations' if attributes.key?(:'idcsPreventedOperations') && attributes.key?(:'idcs_prevented_operations')

  self.idcs_prevented_operations = attributes[:'idcs_prevented_operations'] if attributes[:'idcs_prevented_operations']

  self.tags = attributes[:'tags'] if attributes[:'tags']

  self.idcs_locked_operations = attributes[:'idcsLockedOperations'] if attributes[:'idcsLockedOperations']

  raise 'You cannot provide both :idcsLockedOperations and :idcs_locked_operations' if attributes.key?(:'idcsLockedOperations') && attributes.key?(:'idcs_locked_operations')

  self.idcs_locked_operations = attributes[:'idcs_locked_operations'] if attributes[:'idcs_locked_operations']

  self.idcs_locked_by = attributes[:'idcsLockedBy'] if attributes[:'idcsLockedBy']

  raise 'You cannot provide both :idcsLockedBy and :idcs_locked_by' if attributes.key?(:'idcsLockedBy') && attributes.key?(:'idcs_locked_by')

  self.idcs_locked_by = attributes[:'idcs_locked_by'] if attributes[:'idcs_locked_by']

  self.idcs_locked_on = attributes[:'idcsLockedOn'] if attributes[:'idcsLockedOn']

  raise 'You cannot provide both :idcsLockedOn and :idcs_locked_on' if attributes.key?(:'idcsLockedOn') && attributes.key?(:'idcs_locked_on')

  self.idcs_locked_on = attributes[:'idcs_locked_on'] if attributes[:'idcs_locked_on']

  self.delete_in_progress = attributes[:'deleteInProgress'] unless attributes[:'deleteInProgress'].nil?

  raise 'You cannot provide both :deleteInProgress and :delete_in_progress' if attributes.key?(:'deleteInProgress') && attributes.key?(:'delete_in_progress')

  self.delete_in_progress = attributes[:'delete_in_progress'] unless attributes[:'delete_in_progress'].nil?

  self.idcs_last_upgraded_in_release = attributes[:'idcsLastUpgradedInRelease'] if attributes[:'idcsLastUpgradedInRelease']

  raise 'You cannot provide both :idcsLastUpgradedInRelease and :idcs_last_upgraded_in_release' if attributes.key?(:'idcsLastUpgradedInRelease') && attributes.key?(:'idcs_last_upgraded_in_release')

  self.idcs_last_upgraded_in_release = attributes[:'idcs_last_upgraded_in_release'] if attributes[:'idcs_last_upgraded_in_release']

  self.domain_ocid = attributes[:'domainOcid'] if attributes[:'domainOcid']

  raise 'You cannot provide both :domainOcid and :domain_ocid' if attributes.key?(:'domainOcid') && attributes.key?(:'domain_ocid')

  self.domain_ocid = attributes[:'domain_ocid'] if attributes[:'domain_ocid']

  self.compartment_ocid = attributes[:'compartmentOcid'] if attributes[:'compartmentOcid']

  raise 'You cannot provide both :compartmentOcid and :compartment_ocid' if attributes.key?(:'compartmentOcid') && attributes.key?(:'compartment_ocid')

  self.compartment_ocid = attributes[:'compartment_ocid'] if attributes[:'compartment_ocid']

  self.tenancy_ocid = attributes[:'tenancyOcid'] if attributes[:'tenancyOcid']

  raise 'You cannot provide both :tenancyOcid and :tenancy_ocid' if attributes.key?(:'tenancyOcid') && attributes.key?(:'tenancy_ocid')

  self.tenancy_ocid = attributes[:'tenancy_ocid'] if attributes[:'tenancy_ocid']

  self.provider = attributes[:'provider'] if attributes[:'provider']

  self.verification_url = attributes[:'verificationUrl'] if attributes[:'verificationUrl']

  raise 'You cannot provide both :verificationUrl and :verification_url' if attributes.key?(:'verificationUrl') && attributes.key?(:'verification_url')

  self.verification_url = attributes[:'verification_url'] if attributes[:'verification_url']

  self.service_type = attributes[:'serviceType'] if attributes[:'serviceType']

  raise 'You cannot provide both :serviceType and :service_type' if attributes.key?(:'serviceType') && attributes.key?(:'service_type')

  self.service_type = attributes[:'service_type'] if attributes[:'service_type']

  self.configuration = attributes[:'configuration'] if attributes[:'configuration']
end

Instance Attribute Details

#compartment_ocid ⇒ String

OCI Compartment Id (OCID) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


190
191
192
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 190

def compartment_ocid
  @compartment_ocid
end

#configuration ⇒ Array<OCI::IdentityDomains::Models::IdentityProofingProviderTemplateConfiguration>

Proofing Provider Configuration Template.

SCIM++ Properties: - idcsCompositeKey: [name] - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex

Returns:



257
258
259
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 257

def configuration
  @configuration
end

#delete_in_progress ⇒ BOOLEAN

A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.

SCIM++ Properties: - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: default - type: boolean - uniqueness: none

Returns:

  • (BOOLEAN) 


148
149
150
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 148

def delete_in_progress
  @delete_in_progress
end

#domain_ocid ⇒ String

OCI Domain Id (OCID) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


176
177
178
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 176

def domain_ocid
  @domain_ocid
end

#id ⇒ String

Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 38

def id
  @id
end

#idcs_created_by ⇒ OCI::IdentityDomains::Models::IdcsCreatedBy

Returns:



72
73
74
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 72

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_by ⇒ OCI::IdentityDomains::Models::IdcsLastModifiedBy

Returns:



75
76
77
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 75

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_release ⇒ String

The release number when the resource was upgraded.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (String) 


162
163
164
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 162

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_locked_by ⇒ OCI::IdentityDomains::Models::IdentityProofingProviderTemplateIdcsLockedBy

Returns:



120
121
122
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 120

def idcs_locked_by
  @idcs_locked_by
end

#idcs_locked_on ⇒ String

The most recent DateTime the resource was locked.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: dateTime - uniqueness: none

Returns:

  • (String) 


134
135
136
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 134

def idcs_locked_on
  @idcs_locked_on
end

#idcs_locked_operations ⇒ Array<String>

Operations that are locked on the resource.

SCIM++ Properties: - idcsSearchable: false - idcsCsvAttributeNameMappings: [[columnHeaderName:Locked Operations, multiValueDelimiter:;]] - multiValued: true - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


117
118
119
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 117

def idcs_locked_operations
  @idcs_locked_operations
end

#idcs_prevented_operations ⇒ Array<String>

Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: request - type: string - uniqueness: none

Returns:

  • (Array<String>) 


88
89
90
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 88

def idcs_prevented_operations
  @idcs_prevented_operations
end

#meta ⇒ OCI::IdentityDomains::Models::Meta

Returns:



69
70
71
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 69

def meta
  @meta
end

#ocid ⇒ String

Unique OCI identifier for the SCIM Resource.

SCIM++ Properties: - caseExact: true - idcsSearchable: true - multiValued: false - mutability: immutable - required: false - returned: default - type: string - uniqueness: global

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 52

def ocid
  @ocid
end

#provider ⇒ String

[Required] Name of the Identity Proofing Provider.

SCIM++ Properties: - idcsSearchable: true - multiValued: false - mutability: readWrite - required: true - returned: always - type: string - uniqueness: global

Returns:

  • (String) 


217
218
219
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 217

def provider
  @provider
end

#schemas ⇒ Array<String>

[Required] REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


66
67
68
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 66

def schemas
  @schemas
end

#service_type ⇒ Array<String>

[Required] Service type supported by the Identity Proofing Provider.

Added In: 2505161800

SCIM++ Properties: - idcsSearchable: false - multiValued: true - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (Array<String>) 


245
246
247
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 245

def service_type
  @service_type
end

#tags ⇒ Array<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

Returns:



103
104
105
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 103

def tags
  @tags
end

#tenancy_ocid ⇒ String

OCI Tenant Id (OCID) in which the resource lives.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


204
205
206
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 204

def tenancy_ocid
  @tenancy_ocid
end

#verification_url ⇒ String

[Required] verification URL.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


230
231
232
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 230

def verification_url
  @verification_url
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 260

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'ocid': :'ocid',
    'schemas': :'schemas',
    'meta': :'meta',
    'idcs_created_by': :'idcsCreatedBy',
    'idcs_last_modified_by': :'idcsLastModifiedBy',
    'idcs_prevented_operations': :'idcsPreventedOperations',
    'tags': :'tags',
    'idcs_locked_operations': :'idcsLockedOperations',
    'idcs_locked_by': :'idcsLockedBy',
    'idcs_locked_on': :'idcsLockedOn',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'provider': :'provider',
    'verification_url': :'verificationUrl',
    'service_type': :'serviceType',
    'configuration': :'configuration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 288

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'ocid': :'String',
    'schemas': :'Array<String>',
    'meta': :'OCI::IdentityDomains::Models::Meta',
    'idcs_created_by': :'OCI::IdentityDomains::Models::IdcsCreatedBy',
    'idcs_last_modified_by': :'OCI::IdentityDomains::Models::IdcsLastModifiedBy',
    'idcs_prevented_operations': :'Array<String>',
    'tags': :'Array<OCI::IdentityDomains::Models::Tags>',
    'idcs_locked_operations': :'Array<String>',
    'idcs_locked_by': :'OCI::IdentityDomains::Models::IdentityProofingProviderTemplateIdcsLockedBy',
    'idcs_locked_on': :'String',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'provider': :'String',
    'verification_url': :'String',
    'service_type': :'Array<String>',
    'configuration': :'Array<OCI::IdentityDomains::Models::IdentityProofingProviderTemplateConfiguration>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 487

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    ocid == other.ocid &&
    schemas == other.schemas &&
    meta == other.meta &&
    idcs_created_by == other.idcs_created_by &&
    idcs_last_modified_by == other.idcs_last_modified_by &&
    idcs_prevented_operations == other.idcs_prevented_operations &&
    tags == other.tags &&
    idcs_locked_operations == other.idcs_locked_operations &&
    idcs_locked_by == other.idcs_locked_by &&
    idcs_locked_on == other.idcs_locked_on &&
    delete_in_progress == other.delete_in_progress &&
    idcs_last_upgraded_in_release == other.idcs_last_upgraded_in_release &&
    domain_ocid == other.domain_ocid &&
    compartment_ocid == other.compartment_ocid &&
    tenancy_ocid == other.tenancy_ocid &&
    provider == other.provider &&
    verification_url == other.verification_url &&
    service_type == other.service_type &&
    configuration == other.configuration
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



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 536

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


516
517
518
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 516

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



525
526
527
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 525

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, idcs_locked_operations, idcs_locked_by, idcs_locked_on, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, provider, verification_url, service_type, configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 569

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



563
564
565
 
# File 'lib/oci/identity_domains/models/identity_proofing_provider_template.rb', line 563

def to_s
  to_hash.to_s
end