UserPhoneNumbers

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

Bases: object

Phone numbers

Attributes

TYPE_FAX A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_HOME A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_MOBILE A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_OTHER A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_PAGER A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_RECOVERY A constant which can be used with the type property of a UserPhoneNumbers.
TYPE_WORK A constant which can be used with the type property of a UserPhoneNumbers.
display Gets the display of this UserPhoneNumbers.
primary Gets the primary of this UserPhoneNumbers.
type [Required] Gets the type of this UserPhoneNumbers.
value [Required] Gets the value of this UserPhoneNumbers.
verified Gets the verified of this UserPhoneNumbers.

Methods

__init__(**kwargs) Initializes a new UserPhoneNumbers object with values from keyword arguments.
TYPE_FAX = 'fax'

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

TYPE_HOME = 'home'

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

TYPE_MOBILE = 'mobile'

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

TYPE_OTHER = 'other'

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

TYPE_PAGER = 'pager'

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

TYPE_RECOVERY = 'recovery'

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

TYPE_WORK = 'work'

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

__init__(**kwargs)

Initializes a new UserPhoneNumbers 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 UserPhoneNumbers.
  • display (str) – The value to assign to the display property of this UserPhoneNumbers.
  • type (str) – The value to assign to the type property of this UserPhoneNumbers. Allowed values for this property are: “work”, “home”, “mobile”, “fax”, “pager”, “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 UserPhoneNumbers.
  • verified (bool) – The value to assign to the verified property of this UserPhoneNumbers.
display

Gets the display of this UserPhoneNumbers. A human-readable name, primarily used for display purposes. READ ONLY

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

Gets the primary of this UserPhoneNumbers. A Boolean value that indicates the ‘primary’ or preferred attribute value for this attribute–for example, the preferred phone number or primary phone number. 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 UserPhoneNumbers.
Return type:bool
type

[Required] Gets the type of this UserPhoneNumbers. A label that indicates the attribute’s function- for example, ‘work’, ‘home’, or ‘mobile’

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”, “mobile”, “fax”, “pager”, “other”, “recovery”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

[Required] Gets the value of this UserPhoneNumbers. User’s phone number

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

Gets the verified of this UserPhoneNumbers. A Boolean value that indicates if the phone number is verified.

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