Class: OCI::IdentityDomains::Models::MyTrustedUserAgent

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

Overview

This schema defines the attributes of Trusted User Agents owned by users. Multi-Factor Authentication uses Trusted User Agents to authenticate users. A User Agent is software application that a user uses to issue requests.r For example, a User Agent could be a particular browser (possibly one of several executing on a desktop or laptop) or a particular mobile application (again, one of several executing on a particular mobile device). r A User Agent is trusted once the Multi-Factor Authentication has verified it in some way.

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
TOKEN_TYPE_ENUM =
[
  TOKEN_TYPE_KMSI = 'KMSI'.freeze,
  TOKEN_TYPE_TRUSTED = 'TRUSTED'.freeze,
  TOKEN_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MyTrustedUserAgent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 391

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.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.name = attributes[:'name'] if attributes[:'name']

  self.trust_token = attributes[:'trustToken'] if attributes[:'trustToken']

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

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

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

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

  self.expiry_time = attributes[:'expiryTime'] if attributes[:'expiryTime']

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

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

  self.last_used_on = attributes[:'lastUsedOn'] if attributes[:'lastUsedOn']

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

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

  self.token_type = attributes[:'tokenType'] if attributes[:'tokenType']

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

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

  self.trusted_factors = attributes[:'trustedFactors'] if attributes[:'trustedFactors']

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

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

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

Instance Attribute Details

#compartment_ocidString

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)


159
160
161
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 159

def compartment_ocid
  @compartment_ocid
end

#delete_in_progressBOOLEAN

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)


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

def delete_in_progress
  @delete_in_progress
end

#domain_ocidString

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)


145
146
147
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 145

def domain_ocid
  @domain_ocid
end

#expiry_timeString

Validation period of the trust token.

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

Returns:

  • (String)


248
249
250
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 248

def expiry_time
  @expiry_time
end

#idString

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: false - idcsSearchable: true - multiValued: false - mutability: readOnly - required: false - returned: always - type: string - uniqueness: global

Returns:

  • (String)


39
40
41
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 39

def id
  @id
end

#idcs_created_byOCI::IdentityDomains::Models::IdcsCreatedBy



73
74
75
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 73

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_byOCI::IdentityDomains::Models::IdcsLastModifiedBy



76
77
78
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 76

def idcs_last_modified_by
  @idcs_last_modified_by
end

#idcs_last_upgraded_in_releaseString

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)


131
132
133
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 131

def idcs_last_upgraded_in_release
  @idcs_last_upgraded_in_release
end

#idcs_prevented_operationsArray<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>)


89
90
91
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 89

def idcs_prevented_operations
  @idcs_prevented_operations
end

#last_used_onString

Indicates when this token was used lastime.

Added In: 2111190457

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

Returns:

  • (String)


265
266
267
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 265

def last_used_on
  @last_used_on
end

#locationString

Trust token issued geo-location.

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

Returns:

  • (String)


219
220
221
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 219

def location
  @location
end

#metaOCI::IdentityDomains::Models::Meta



70
71
72
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 70

def meta
  @meta
end

#nameString

[Required] The name of the User Agent that the user wants the system to trust and to use in Multi-Factor Authentication.

SCIM++ Properties: - caseExact: false - idcsSearchable: false - multiValued: false - mutability: immutable - idcsRequiresWriteForAccessFlows: true - required: true - returned: always - type: string - uniqueness: none

Returns:

  • (String)


188
189
190
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 188

def name
  @name
end

#ocidString

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)


53
54
55
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 53

def ocid
  @ocid
end

#platformString

User agent platform for which the trust token has been issued.

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

Returns:

  • (String)


233
234
235
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 233

def platform
  @platform
end

#schemasArray<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>)


67
68
69
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 67

def schemas
  @schemas
end

#tagsArray<OCI::IdentityDomains::Models::Tags>

A list of tags on this resource.

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none



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

def tags
  @tags
end

#tenancy_ocidString

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)


173
174
175
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 173

def tenancy_ocid
  @tenancy_ocid
end

#token_typeString

The token type being created. This token is used as trusted and kmsi token.

Added In: 2111190457

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

Returns:

  • (String)


281
282
283
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 281

def token_type
  @token_type
end

#trust_tokenString

[Required] Trust token for the user agent. This is a random string value that will be updated whenever a token that has been issued is verified successfully.

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

Returns:

  • (String)


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

def trust_token
  @trust_token
end

#trusted_factorsArray<OCI::IdentityDomains::Models::MyTrustedUserAgentTrustedFactors>

Trusted 2FA Factors

Added In: 19.2.1

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



297
298
299
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 297

def trusted_factors
  @trusted_factors
end

#userOCI::IdentityDomains::Models::MyTrustedUserAgentUser

This attribute is required.



301
302
303
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 301

def user
  @user
end

Class Method Details

.attribute_mapObject

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



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

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',
    'delete_in_progress': :'deleteInProgress',
    'idcs_last_upgraded_in_release': :'idcsLastUpgradedInRelease',
    'domain_ocid': :'domainOcid',
    'compartment_ocid': :'compartmentOcid',
    'tenancy_ocid': :'tenancyOcid',
    'name': :'name',
    'trust_token': :'trustToken',
    'location': :'location',
    'platform': :'platform',
    'expiry_time': :'expiryTime',
    'last_used_on': :'lastUsedOn',
    'token_type': :'tokenType',
    'trusted_factors': :'trustedFactors',
    'user': :'user'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 334

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>',
    'delete_in_progress': :'BOOLEAN',
    'idcs_last_upgraded_in_release': :'String',
    'domain_ocid': :'String',
    'compartment_ocid': :'String',
    'tenancy_ocid': :'String',
    'name': :'String',
    'trust_token': :'String',
    'location': :'String',
    'platform': :'String',
    'expiry_time': :'String',
    'last_used_on': :'String',
    'token_type': :'String',
    'trusted_factors': :'Array<OCI::IdentityDomains::Models::MyTrustedUserAgentTrustedFactors>',
    'user': :'OCI::IdentityDomains::Models::MyTrustedUserAgentUser'
    # 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



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

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 &&
    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 &&
    name == other.name &&
    trust_token == other.trust_token &&
    location == other.location &&
    platform == other.platform &&
    expiry_time == other.expiry_time &&
    last_used_on == other.last_used_on &&
    token_type == other.token_type &&
    trusted_factors == other.trusted_factors &&
    user == other.user
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



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 585

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


565
566
567
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 565

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



574
575
576
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 574

def hash
  [id, ocid, schemas, meta, idcs_created_by, idcs_last_modified_by, idcs_prevented_operations, tags, delete_in_progress, idcs_last_upgraded_in_release, domain_ocid, compartment_ocid, tenancy_ocid, name, trust_token, location, platform, expiry_time, last_used_on, token_type, trusted_factors, user].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



618
619
620
621
622
623
624
625
626
627
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 618

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



612
613
614
# File 'lib/oci/identity_domains/models/my_trusted_user_agent.rb', line 612

def to_s
  to_hash.to_s
end