Class: OCI::IdentityDomains::Models::MyDevice

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

Overview

Device Resource.

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
PLATFORM_ENUM =
[
  PLATFORM_IOS = 'IOS'.freeze,
  PLATFORM_ANDROID = 'ANDROID'.freeze,
  PLATFORM_WINDOWS = 'WINDOWS'.freeze,
  PLATFORM_CELLULAR = 'CELLULAR'.freeze,
  PLATFORM_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM =
[
  STATUS_INITIATED = 'INITIATED'.freeze,
  STATUS_INPROGRESS = 'INPROGRESS'.freeze,
  STATUS_INACTIVE = 'INACTIVE'.freeze,
  STATUS_ENROLLED = 'ENROLLED'.freeze,
  STATUS_LOCKED = 'LOCKED'.freeze,
  STATUS_BLOCKED = 'BLOCKED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MyDevice

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
# File 'lib/oci/identity_domains/models/my_device.rb', line 679

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

  self.device_type = attributes[:'deviceType'] if attributes[:'deviceType']

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

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

  self.app_version = attributes[:'appVersion'] if attributes[:'appVersion']

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

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

  self.package_id = attributes[:'packageId'] if attributes[:'packageId']

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

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

  self.last_sync_time = attributes[:'lastSyncTime'] if attributes[:'lastSyncTime']

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

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

  self.last_validated_time = attributes[:'lastValidatedTime'] if attributes[:'lastValidatedTime']

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

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

  self.is_compliant = attributes[:'isCompliant'] unless attributes[:'isCompliant'].nil?

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

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

  self.country_code = attributes[:'countryCode'] if attributes[:'countryCode']

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

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

  self.phone_number = attributes[:'phoneNumber'] if attributes[:'phoneNumber']

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

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

  self.is_acc_rec_enabled = attributes[:'isAccRecEnabled'] unless attributes[:'isAccRecEnabled'].nil?

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

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

  self.device_uuid = attributes[:'deviceUUID'] if attributes[:'deviceUUID']

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

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

  self.base_public_key = attributes[:'basePublicKey'] if attributes[:'basePublicKey']

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

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

  self.authentication_method = attributes[:'authenticationMethod'] if attributes[:'authenticationMethod']

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

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

  self.expires_on = attributes[:'expiresOn'] if attributes[:'expiresOn']

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

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

  self.seed_dek_id = attributes[:'seedDekId'] if attributes[:'seedDekId']

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

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

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

  self.third_party_factor = attributes[:'thirdPartyFactor'] if attributes[:'thirdPartyFactor']

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

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

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

  self.push_notification_target = attributes[:'pushNotificationTarget'] if attributes[:'pushNotificationTarget']

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

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

  self.additional_attributes = attributes[:'additionalAttributes'] if attributes[:'additionalAttributes']

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

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

  self.authentication_factors = attributes[:'authenticationFactors'] if attributes[:'authenticationFactors']

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

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

  self.non_compliances = attributes[:'nonCompliances'] if attributes[:'nonCompliances']

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

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

Instance Attribute Details

#additional_attributesArray<OCI::IdentityDomains::Models::MyDeviceAdditionalAttributes>

Device additional attributes

SCIM++ Properties: - idcsCompositeKey: [key, value] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex



511
512
513
# File 'lib/oci/identity_domains/models/my_device.rb', line 511

def additional_attributes
  @additional_attributes
end

#app_versionString

Mobile Authenticator App Version

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

Returns:

  • (String)


286
287
288
# File 'lib/oci/identity_domains/models/my_device.rb', line 286

def app_version
  @app_version
end

#authentication_factorsArray<OCI::IdentityDomains::Models::MyDeviceAuthenticationFactors>

[Required] Authentication Factors

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



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

def authentication_factors
  @authentication_factors
end

#authentication_methodString

Authentication method used in device. For FIDO, it will contain SECURITY_KEY/WINDOWS_HELLO etc

Added In: 2009232244

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

Returns:

  • (String)


443
444
445
# File 'lib/oci/identity_domains/models/my_device.rb', line 443

def authentication_method
  @authentication_method
end

#base_public_keyString

Device base public Key

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

Returns:

  • (String)


426
427
428
# File 'lib/oci/identity_domains/models/my_device.rb', line 426

def base_public_key
  @base_public_key
end

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


169
170
171
# File 'lib/oci/identity_domains/models/my_device.rb', line 169

def compartment_ocid
  @compartment_ocid
end

#country_codeString

Country code of user's Phone Number

Added In: 19.1.4

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

Returns:

  • (String)


365
366
367
# File 'lib/oci/identity_domains/models/my_device.rb', line 365

def country_code
  @country_code
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)


127
128
129
# File 'lib/oci/identity_domains/models/my_device.rb', line 127

def delete_in_progress
  @delete_in_progress
end

#device_typeString

Device hardware name/model

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

Returns:

  • (String)


271
272
273
# File 'lib/oci/identity_domains/models/my_device.rb', line 271

def device_type
  @device_type
end

#device_uuidString

Unique id sent from device

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

Returns:

  • (String)


411
412
413
# File 'lib/oci/identity_domains/models/my_device.rb', line 411

def device_uuid
  @device_uuid
end

#display_nameString

Device friendly display name

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

Returns:

  • (String)


212
213
214
# File 'lib/oci/identity_domains/models/my_device.rb', line 212

def display_name
  @display_name
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)


155
156
157
# File 'lib/oci/identity_domains/models/my_device.rb', line 155

def domain_ocid
  @domain_ocid
end

#expires_onInteger

Attribute added for replication log, it is not used by IDCS, just added as place holder

Added In: 2111040242

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

Returns:

  • (Integer)


458
459
460
# File 'lib/oci/identity_domains/models/my_device.rb', line 458

def expires_on
  @expires_on
end

#external_idString

An identifier for the Resource as defined by the Service Consumer. The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued be the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer's tenant.

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

Returns:

  • (String)


196
197
198
# File 'lib/oci/identity_domains/models/my_device.rb', line 196

def external_id
  @external_id
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)


49
50
51
# File 'lib/oci/identity_domains/models/my_device.rb', line 49

def id
  @id
end

#idcs_created_byOCI::IdentityDomains::Models::IdcsCreatedBy



83
84
85
# File 'lib/oci/identity_domains/models/my_device.rb', line 83

def idcs_created_by
  @idcs_created_by
end

#idcs_last_modified_byOCI::IdentityDomains::Models::IdcsLastModifiedBy



86
87
88
# File 'lib/oci/identity_domains/models/my_device.rb', line 86

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)


141
142
143
# File 'lib/oci/identity_domains/models/my_device.rb', line 141

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


99
100
101
# File 'lib/oci/identity_domains/models/my_device.rb', line 99

def idcs_prevented_operations
  @idcs_prevented_operations
end

#is_acc_rec_enabledBOOLEAN

Flag that indicates whether the device is enrolled for account recovery

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

Returns:

  • (BOOLEAN)


396
397
398
# File 'lib/oci/identity_domains/models/my_device.rb', line 396

def is_acc_rec_enabled
  @is_acc_rec_enabled
end

#is_compliantBOOLEAN

Device Compliance Status

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

Returns:

  • (BOOLEAN)


348
349
350
# File 'lib/oci/identity_domains/models/my_device.rb', line 348

def is_compliant
  @is_compliant
end

#last_sync_timeString

Last Sync time for device

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

Returns:

  • (String)


316
317
318
# File 'lib/oci/identity_domains/models/my_device.rb', line 316

def last_sync_time
  @last_sync_time
end

#last_validated_timeString

The most recent timestamp when the device was successfully validated using one time passcode

Added In: 17.3.6

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

Returns:

  • (String)


334
335
336
# File 'lib/oci/identity_domains/models/my_device.rb', line 334

def last_validated_time
  @last_validated_time
end

#metaOCI::IdentityDomains::Models::Meta



80
81
82
# File 'lib/oci/identity_domains/models/my_device.rb', line 80

def meta
  @meta
end

#non_compliancesArray<OCI::IdentityDomains::Models::MyDeviceNonCompliances>

Device Non Compliances

SCIM++ Properties: - idcsCompositeKey: [name, value] - idcsSearchable: false - multiValued: true - mutability: readOnly - required: false - returned: default - type: complex



538
539
540
# File 'lib/oci/identity_domains/models/my_device.rb', line 538

def non_compliances
  @non_compliances
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)


63
64
65
# File 'lib/oci/identity_domains/models/my_device.rb', line 63

def ocid
  @ocid
end

#package_idString

Mobile Authenticator App Package Id

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

Returns:

  • (String)


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

def package_id
  @package_id
end

#phone_numberString

User's Phone Number

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

Returns:

  • (String)


380
381
382
# File 'lib/oci/identity_domains/models/my_device.rb', line 380

def phone_number
  @phone_number
end

#platformString

Device Platform

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

Returns:

  • (String)


227
228
229
# File 'lib/oci/identity_domains/models/my_device.rb', line 227

def platform
  @platform
end

#push_notification_targetOCI::IdentityDomains::Models::MyDevicePushNotificationTarget



498
499
500
# File 'lib/oci/identity_domains/models/my_device.rb', line 498

def push_notification_target
  @push_notification_target
end

#reasonString

Additional comments/reasons for the change in device status

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

Returns:

  • (String)


256
257
258
# File 'lib/oci/identity_domains/models/my_device.rb', line 256

def reason
  @reason
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>)


77
78
79
# File 'lib/oci/identity_domains/models/my_device.rb', line 77

def schemas
  @schemas
end

#seedString

Attribute added for replication log, it is not used by IDCS, it is actual encrypted TOTP seed for the user

Added In: 2111040242

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

Returns:

  • (String)


488
489
490
# File 'lib/oci/identity_domains/models/my_device.rb', line 488

def seed
  @seed
end

#seed_dek_idString

Attribute added for replication log, it is not used by IDCS, the DEK that encrypts the specific seed for that user

Added In: 2111040242

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

Returns:

  • (String)


473
474
475
# File 'lib/oci/identity_domains/models/my_device.rb', line 473

def seed_dek_id
  @seed_dek_id
end

#statusString

Device Status

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

Returns:

  • (String)


243
244
245
# File 'lib/oci/identity_domains/models/my_device.rb', line 243

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



113
114
115
# File 'lib/oci/identity_domains/models/my_device.rb', line 113

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)


183
184
185
# File 'lib/oci/identity_domains/models/my_device.rb', line 183

def tenancy_ocid
  @tenancy_ocid
end

#third_party_factorOCI::IdentityDomains::Models::MyDeviceThirdPartyFactor



491
492
493
# File 'lib/oci/identity_domains/models/my_device.rb', line 491

def third_party_factor
  @third_party_factor
end

#userOCI::IdentityDomains::Models::MyDeviceUser

This attribute is required.



495
496
497
# File 'lib/oci/identity_domains/models/my_device.rb', line 495

def user
  @user
end

Class Method Details

.attribute_mapObject

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



541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
# File 'lib/oci/identity_domains/models/my_device.rb', line 541

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',
    'external_id': :'externalId',
    'display_name': :'displayName',
    'platform': :'platform',
    'status': :'status',
    'reason': :'reason',
    'device_type': :'deviceType',
    'app_version': :'appVersion',
    'package_id': :'packageId',
    'last_sync_time': :'lastSyncTime',
    'last_validated_time': :'lastValidatedTime',
    'is_compliant': :'isCompliant',
    'country_code': :'countryCode',
    'phone_number': :'phoneNumber',
    'is_acc_rec_enabled': :'isAccRecEnabled',
    'device_uuid': :'deviceUUID',
    'base_public_key': :'basePublicKey',
    'authentication_method': :'authenticationMethod',
    'expires_on': :'expiresOn',
    'seed_dek_id': :'seedDekId',
    'seed': :'seed',
    'third_party_factor': :'thirdPartyFactor',
    'user': :'user',
    'push_notification_target': :'pushNotificationTarget',
    'additional_attributes': :'additionalAttributes',
    'authentication_factors': :'authenticationFactors',
    'non_compliances': :'nonCompliances'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
# File 'lib/oci/identity_domains/models/my_device.rb', line 588

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',
    'external_id': :'String',
    'display_name': :'String',
    'platform': :'String',
    'status': :'String',
    'reason': :'String',
    'device_type': :'String',
    'app_version': :'String',
    'package_id': :'String',
    'last_sync_time': :'String',
    'last_validated_time': :'String',
    'is_compliant': :'BOOLEAN',
    'country_code': :'String',
    'phone_number': :'String',
    'is_acc_rec_enabled': :'BOOLEAN',
    'device_uuid': :'String',
    'base_public_key': :'String',
    'authentication_method': :'String',
    'expires_on': :'Integer',
    'seed_dek_id': :'String',
    'seed': :'String',
    'third_party_factor': :'OCI::IdentityDomains::Models::MyDeviceThirdPartyFactor',
    'user': :'OCI::IdentityDomains::Models::MyDeviceUser',
    'push_notification_target': :'OCI::IdentityDomains::Models::MyDevicePushNotificationTarget',
    'additional_attributes': :'Array<OCI::IdentityDomains::Models::MyDeviceAdditionalAttributes>',
    'authentication_factors': :'Array<OCI::IdentityDomains::Models::MyDeviceAuthenticationFactors>',
    'non_compliances': :'Array<OCI::IdentityDomains::Models::MyDeviceNonCompliances>'
    # 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



933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/oci/identity_domains/models/my_device.rb', line 933

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 &&
    external_id == other.external_id &&
    display_name == other.display_name &&
    platform == other.platform &&
    status == other.status &&
    reason == other.reason &&
    device_type == other.device_type &&
    app_version == other.app_version &&
    package_id == other.package_id &&
    last_sync_time == other.last_sync_time &&
    last_validated_time == other.last_validated_time &&
    is_compliant == other.is_compliant &&
    country_code == other.country_code &&
    phone_number == other.phone_number &&
    is_acc_rec_enabled == other.is_acc_rec_enabled &&
    device_uuid == other.device_uuid &&
    base_public_key == other.base_public_key &&
    authentication_method == other.authentication_method &&
    expires_on == other.expires_on &&
    seed_dek_id == other.seed_dek_id &&
    seed == other.seed &&
    third_party_factor == other.third_party_factor &&
    user == other.user &&
    push_notification_target == other.push_notification_target &&
    additional_attributes == other.additional_attributes &&
    authentication_factors == other.authentication_factors &&
    non_compliances == other.non_compliances
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



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
# File 'lib/oci/identity_domains/models/my_device.rb', line 1001

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


981
982
983
# File 'lib/oci/identity_domains/models/my_device.rb', line 981

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



990
991
992
# File 'lib/oci/identity_domains/models/my_device.rb', line 990

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, external_id, display_name, platform, status, reason, device_type, app_version, package_id, last_sync_time, last_validated_time, is_compliant, country_code, phone_number, is_acc_rec_enabled, device_uuid, base_public_key, authentication_method, expires_on, seed_dek_id, seed, third_party_factor, user, push_notification_target, additional_attributes, authentication_factors, non_compliances].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
# File 'lib/oci/identity_domains/models/my_device.rb', line 1034

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



1028
1029
1030
# File 'lib/oci/identity_domains/models/my_device.rb', line 1028

def to_s
  to_hash.to_s
end