UserEmails

class oci.identity_domains.models.UserEmails(**kwargs)

Bases: object

A complex attribute representing emails

Attributes

TYPE_HOME A constant which can be used with the type property of a UserEmails.
TYPE_OTHER A constant which can be used with the type property of a UserEmails.
TYPE_RECOVERY A constant which can be used with the type property of a UserEmails.
TYPE_WORK A constant which can be used with the type property of a UserEmails.
pending_verification_data Gets the pending_verification_data of this UserEmails.
primary Gets the primary of this UserEmails.
secondary Gets the secondary of this UserEmails.
type [Required] Gets the type of this UserEmails.
value [Required] Gets the value of this UserEmails.
verified Gets the verified of this UserEmails.

Methods

__init__(**kwargs) Initializes a new UserEmails object with values from keyword arguments.
TYPE_HOME = 'home'

A constant which can be used with the type property of a UserEmails. This constant has a value of “home”

TYPE_OTHER = 'other'

A constant which can be used with the type property of a UserEmails. This constant has a value of “other”

TYPE_RECOVERY = 'recovery'

A constant which can be used with the type property of a UserEmails. This constant has a value of “recovery”

TYPE_WORK = 'work'

A constant which can be used with the type property of a UserEmails. This constant has a value of “work”

__init__(**kwargs)

Initializes a new UserEmails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • value (str) – The value to assign to the value property of this UserEmails.
  • type (str) – The value to assign to the type property of this UserEmails. Allowed values for this property are: “work”, “home”, “other”, “recovery”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • primary (bool) – The value to assign to the primary property of this UserEmails.
  • secondary (bool) – The value to assign to the secondary property of this UserEmails.
  • verified (bool) – The value to assign to the verified property of this UserEmails.
  • pending_verification_data (str) – The value to assign to the pending_verification_data property of this UserEmails.
pending_verification_data

Gets the pending_verification_data of this UserEmails. Pending e-mail address verification

Added In: 19.1.4

SCIM++ Properties:
  • caseExact: false
  • multiValued: false
  • mutability: readOnly
  • required: false
  • returned: default
  • type: string
  • uniqueness: none
Returns:The pending_verification_data of this UserEmails.
Return type:str
primary

Gets the primary of this UserEmails. A Boolean value that indicates whether the email address is the primary email address. The primary attribute value ‘true’ MUST appear no more than once.

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none
Returns:The primary of this UserEmails.
Return type:bool
secondary

Gets the secondary of this UserEmails. A Boolean value that indicates whether the email address is the secondary email address. The secondary attribute value ‘true’ MUST appear no more than once.

Added In: 18.2.6

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none
Returns:The secondary of this UserEmails.
Return type:bool
type

[Required] Gets the type of this UserEmails. Type of email address

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

Allowed values for this property are: “work”, “home”, “other”, “recovery”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The type of this UserEmails.
Return type:str
value

[Required] Gets the value of this UserEmails. Email address

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none
Returns:The value of this UserEmails.
Return type:str
verified

Gets the verified of this UserEmails. A Boolean value that indicates whether or not the e-mail address is verified

SCIM++ Properties:
  • caseExact: false
  • idcsSearchable: true
  • multiValued: false
  • mutability: readWrite
  • required: false
  • returned: default
  • type: boolean
  • uniqueness: none
Returns:The verified of this UserEmails.
Return type:bool