MyDevice¶
- class oci.identity_domains.models.MyDevice(**kwargs)¶
Bases:
objectDevice Resource.
Attributes:
A constant which can be used with the idcs_prevented_operations property of a MyDevice.
A constant which can be used with the idcs_prevented_operations property of a MyDevice.
A constant which can be used with the idcs_prevented_operations property of a MyDevice.
A constant which can be used with the platform property of a MyDevice.
A constant which can be used with the platform property of a MyDevice.
A constant which can be used with the platform property of a MyDevice.
A constant which can be used with the platform property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
A constant which can be used with the status property of a MyDevice.
Gets the additional_attributes of this MyDevice.
Gets the app_version of this MyDevice.
[Required] Gets the authentication_factors of this MyDevice.
Gets the authentication_method of this MyDevice.
Gets the base_public_key of this MyDevice.
Gets the compartment_ocid of this MyDevice.
Gets the country_code of this MyDevice.
Gets the delete_in_progress of this MyDevice.
Gets the device_type of this MyDevice.
Gets the device_uuid of this MyDevice.
Gets the display_name of this MyDevice.
Gets the domain_ocid of this MyDevice.
Gets the expires_on of this MyDevice.
Gets the external_id of this MyDevice.
Gets the id of this MyDevice.
Gets the idcs_created_by of this MyDevice.
Gets the idcs_last_modified_by of this MyDevice.
Gets the idcs_last_upgraded_in_release of this MyDevice.
Gets the idcs_prevented_operations of this MyDevice.
Gets the is_acc_rec_enabled of this MyDevice.
Gets the is_compliant of this MyDevice.
Gets the last_sync_time of this MyDevice.
Gets the last_validated_time of this MyDevice.
Gets the meta of this MyDevice.
Gets the non_compliances of this MyDevice.
Gets the ocid of this MyDevice.
Gets the package_id of this MyDevice.
Gets the phone_number of this MyDevice.
Gets the platform of this MyDevice.
Gets the push_notification_target of this MyDevice.
Gets the reason of this MyDevice.
[Required] Gets the schemas of this MyDevice.
Gets the seed of this MyDevice.
Gets the seed_dek_id of this MyDevice.
Gets the status of this MyDevice.
Gets the tags of this MyDevice.
Gets the tenancy_ocid of this MyDevice.
Gets the third_party_factor of this MyDevice.
[Required] Gets the user of this MyDevice.
Methods:
__init__(**kwargs)Initializes a new MyDevice object with values from keyword arguments.
- IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶
A constant which can be used with the idcs_prevented_operations property of a MyDevice. This constant has a value of “delete”
- IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶
A constant which can be used with the idcs_prevented_operations property of a MyDevice. This constant has a value of “replace”
- IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶
A constant which can be used with the idcs_prevented_operations property of a MyDevice. This constant has a value of “update”
- PLATFORM_ANDROID = 'ANDROID'¶
A constant which can be used with the platform property of a MyDevice. This constant has a value of “ANDROID”
- PLATFORM_CELLULAR = 'CELLULAR'¶
A constant which can be used with the platform property of a MyDevice. This constant has a value of “CELLULAR”
- PLATFORM_IOS = 'IOS'¶
A constant which can be used with the platform property of a MyDevice. This constant has a value of “IOS”
- PLATFORM_WINDOWS = 'WINDOWS'¶
A constant which can be used with the platform property of a MyDevice. This constant has a value of “WINDOWS”
- STATUS_BLOCKED = 'BLOCKED'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “BLOCKED”
- STATUS_ENROLLED = 'ENROLLED'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “ENROLLED”
- STATUS_INACTIVE = 'INACTIVE'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “INACTIVE”
- STATUS_INITIATED = 'INITIATED'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “INITIATED”
- STATUS_INPROGRESS = 'INPROGRESS'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “INPROGRESS”
- STATUS_LOCKED = 'LOCKED'¶
A constant which can be used with the status property of a MyDevice. This constant has a value of “LOCKED”
- __init__(**kwargs)¶
Initializes a new MyDevice object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
id (str) – The value to assign to the id property of this MyDevice.
ocid (str) – The value to assign to the ocid property of this MyDevice.
schemas (list[str]) – The value to assign to the schemas property of this MyDevice.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this MyDevice.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this MyDevice.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this MyDevice.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this MyDevice. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this MyDevice.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this MyDevice.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this MyDevice.
domain_ocid (str) – The value to assign to the domain_ocid property of this MyDevice.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this MyDevice.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this MyDevice.
external_id (str) – The value to assign to the external_id property of this MyDevice.
display_name (str) – The value to assign to the display_name property of this MyDevice.
platform (str) – The value to assign to the platform property of this MyDevice. Allowed values for this property are: “IOS”, “ANDROID”, “WINDOWS”, “CELLULAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
status (str) – The value to assign to the status property of this MyDevice. Allowed values for this property are: “INITIATED”, “INPROGRESS”, “INACTIVE”, “ENROLLED”, “LOCKED”, “BLOCKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
reason (str) – The value to assign to the reason property of this MyDevice.
device_type (str) – The value to assign to the device_type property of this MyDevice.
app_version (str) – The value to assign to the app_version property of this MyDevice.
package_id (str) – The value to assign to the package_id property of this MyDevice.
last_sync_time (str) – The value to assign to the last_sync_time property of this MyDevice.
last_validated_time (str) – The value to assign to the last_validated_time property of this MyDevice.
is_compliant (bool) – The value to assign to the is_compliant property of this MyDevice.
country_code (str) – The value to assign to the country_code property of this MyDevice.
phone_number (str) – The value to assign to the phone_number property of this MyDevice.
is_acc_rec_enabled (bool) – The value to assign to the is_acc_rec_enabled property of this MyDevice.
device_uuid (str) – The value to assign to the device_uuid property of this MyDevice.
base_public_key (str) – The value to assign to the base_public_key property of this MyDevice.
authentication_method (str) – The value to assign to the authentication_method property of this MyDevice.
expires_on (int) – The value to assign to the expires_on property of this MyDevice.
seed_dek_id (str) – The value to assign to the seed_dek_id property of this MyDevice.
seed (str) – The value to assign to the seed property of this MyDevice.
third_party_factor (oci.identity_domains.models.MyDeviceThirdPartyFactor) – The value to assign to the third_party_factor property of this MyDevice.
user (oci.identity_domains.models.MyDeviceUser) – The value to assign to the user property of this MyDevice.
push_notification_target (oci.identity_domains.models.MyDevicePushNotificationTarget) – The value to assign to the push_notification_target property of this MyDevice.
additional_attributes (list[oci.identity_domains.models.MyDeviceAdditionalAttributes]) – The value to assign to the additional_attributes property of this MyDevice.
authentication_factors (list[oci.identity_domains.models.MyDeviceAuthenticationFactors]) – The value to assign to the authentication_factors property of this MyDevice.
non_compliances (list[oci.identity_domains.models.MyDeviceNonCompliances]) – The value to assign to the non_compliances property of this MyDevice.
- property additional_attributes¶
Gets the additional_attributes of this MyDevice. Device additional attributes
- SCIM++ Properties:
idcsCompositeKey: [key, value]
idcsSearchable: false
multiValued: true
mutability: readOnly
required: false
returned: default
type: complex
- Returns
The additional_attributes of this MyDevice.
- Return type
list[oci.identity_domains.models.MyDeviceAdditionalAttributes]
- property app_version¶
Gets the app_version of this MyDevice. 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
The app_version of this MyDevice.
- Return type
str
- property authentication_factors¶
[Required] Gets the authentication_factors of this MyDevice. Authentication Factors
- SCIM++ Properties:
caseExact: true
idcsCompositeKey: [type]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: true
returned: default
type: complex
- Returns
The authentication_factors of this MyDevice.
- Return type
list[oci.identity_domains.models.MyDeviceAuthenticationFactors]
- property authentication_method¶
Gets the authentication_method of this MyDevice. 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
The authentication_method of this MyDevice.
- Return type
str
- property base_public_key¶
Gets the base_public_key of this MyDevice. 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
The base_public_key of this MyDevice.
- Return type
str
- property compartment_ocid¶
Gets the compartment_ocid of this MyDevice. 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
The compartment_ocid of this MyDevice.
- Return type
str
- property country_code¶
Gets the country_code of this MyDevice. 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
The country_code of this MyDevice.
- Return type
str
- property delete_in_progress¶
Gets the delete_in_progress of this MyDevice. 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
The delete_in_progress of this MyDevice.
- Return type
bool
- property device_type¶
Gets the device_type of this MyDevice. 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
The device_type of this MyDevice.
- Return type
str
- property device_uuid¶
Gets the device_uuid of this MyDevice. 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
The device_uuid of this MyDevice.
- Return type
str
- property display_name¶
Gets the display_name of this MyDevice. 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
The display_name of this MyDevice.
- Return type
str
- property domain_ocid¶
Gets the domain_ocid of this MyDevice. 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
The domain_ocid of this MyDevice.
- Return type
str
- property expires_on¶
Gets the expires_on of this MyDevice. 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
The expires_on of this MyDevice.
- Return type
int
- property external_id¶
Gets the external_id of this MyDevice. 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
The external_id of this MyDevice.
- Return type
str
- property id¶
Gets the id of this MyDevice. 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
The id of this MyDevice.
- Return type
str
- property idcs_created_by¶
Gets the idcs_created_by of this MyDevice.
- Returns
The idcs_created_by of this MyDevice.
- Return type
- property idcs_last_modified_by¶
Gets the idcs_last_modified_by of this MyDevice.
- Returns
The idcs_last_modified_by of this MyDevice.
- Return type
- property idcs_last_upgraded_in_release¶
Gets the idcs_last_upgraded_in_release of this MyDevice. 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
The idcs_last_upgraded_in_release of this MyDevice.
- Return type
str
- property idcs_prevented_operations¶
Gets the idcs_prevented_operations of this MyDevice. 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
Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The idcs_prevented_operations of this MyDevice.
- Return type
list[str]
- property is_acc_rec_enabled¶
Gets the is_acc_rec_enabled of this MyDevice. 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
The is_acc_rec_enabled of this MyDevice.
- Return type
bool
- property is_compliant¶
Gets the is_compliant of this MyDevice. Device Compliance Status
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: boolean
uniqueness: none
- Returns
The is_compliant of this MyDevice.
- Return type
bool
- property last_sync_time¶
Gets the last_sync_time of this MyDevice. 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
The last_sync_time of this MyDevice.
- Return type
str
- property last_validated_time¶
Gets the last_validated_time of this MyDevice. 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
The last_validated_time of this MyDevice.
- Return type
str
- property meta¶
Gets the meta of this MyDevice.
- Returns
The meta of this MyDevice.
- Return type
- property non_compliances¶
Gets the non_compliances of this MyDevice. Device Non Compliances
- SCIM++ Properties:
idcsCompositeKey: [name, value]
idcsSearchable: false
multiValued: true
mutability: readOnly
required: false
returned: default
type: complex
- Returns
The non_compliances of this MyDevice.
- Return type
- property ocid¶
Gets the ocid of this MyDevice. 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
The ocid of this MyDevice.
- Return type
str
- property package_id¶
Gets the package_id of this MyDevice. 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
The package_id of this MyDevice.
- Return type
str
- property phone_number¶
Gets the phone_number of this MyDevice. 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
The phone_number of this MyDevice.
- Return type
str
- property platform¶
Gets the platform of this MyDevice. Device Platform
- SCIM++ Properties:
idcsSearchable: false
multiValued: false
mutability: immutable
idcsRequiresWriteForAccessFlows: true
idcsRequiresImmediateReadAfterWriteForAccessFlows: true
required: false
returned: default
type: string
uniqueness: none
Allowed values for this property are: “IOS”, “ANDROID”, “WINDOWS”, “CELLULAR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The platform of this MyDevice.
- Return type
str
- property push_notification_target¶
Gets the push_notification_target of this MyDevice.
- Returns
The push_notification_target of this MyDevice.
- Return type
- property reason¶
Gets the reason of this MyDevice. 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
The reason of this MyDevice.
- Return type
str
- property schemas¶
[Required] Gets the schemas of this MyDevice. 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
The schemas of this MyDevice.
- Return type
list[str]
- property seed¶
Gets the seed of this MyDevice. 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
The seed of this MyDevice.
- Return type
str
- property seed_dek_id¶
Gets the seed_dek_id of this MyDevice. 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
The seed_dek_id of this MyDevice.
- Return type
str
- property status¶
Gets the status of this MyDevice. Device Status
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
idcsRequiresWriteForAccessFlows: true
idcsRequiresImmediateReadAfterWriteForAccessFlows: true
Allowed values for this property are: “INITIATED”, “INPROGRESS”, “INACTIVE”, “ENROLLED”, “LOCKED”, “BLOCKED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this MyDevice.
- Return type
str
- property tags¶
Gets the tags of this MyDevice. 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
- Returns
The tags of this MyDevice.
- Return type
- property tenancy_ocid¶
Gets the tenancy_ocid of this MyDevice. 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
The tenancy_ocid of this MyDevice.
- Return type
str
- property third_party_factor¶
Gets the third_party_factor of this MyDevice.
- Returns
The third_party_factor of this MyDevice.
- Return type
- property user¶
[Required] Gets the user of this MyDevice.
- Returns
The user of this MyDevice.
- Return type