Addresses¶
- class oci.identity_domains.models.Addresses(**kwargs)¶
Bases:
objectA physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.
Attributes:
A constant which can be used with the type property of a Addresses.
A constant which can be used with the type property of a Addresses.
A constant which can be used with the type property of a Addresses.
Gets the country of this Addresses.
Gets the formatted of this Addresses.
Gets the locality of this Addresses.
Gets the postal_code of this Addresses.
Gets the primary of this Addresses.
Gets the region of this Addresses.
Gets the street_address of this Addresses.
[Required] Gets the type of this Addresses.
Methods:
__init__(**kwargs)Initializes a new Addresses object with values from keyword arguments.
- TYPE_HOME = 'home'¶
A constant which can be used with the type property of a Addresses. This constant has a value of “home”
- TYPE_OTHER = 'other'¶
A constant which can be used with the type property of a Addresses. This constant has a value of “other”
- TYPE_WORK = 'work'¶
A constant which can be used with the type property of a Addresses. This constant has a value of “work”
- __init__(**kwargs)¶
Initializes a new Addresses object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
formatted (str) – The value to assign to the formatted property of this Addresses.
street_address (str) – The value to assign to the street_address property of this Addresses.
locality (str) – The value to assign to the locality property of this Addresses.
region (str) – The value to assign to the region property of this Addresses.
postal_code (str) – The value to assign to the postal_code property of this Addresses.
country (str) – The value to assign to the country property of this Addresses.
type (str) – The value to assign to the type property of this Addresses. Allowed values for this property are: “work”, “home”, “other”, ‘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 Addresses.
- property country¶
Gets the country of this Addresses. The country name component.
- SCIM++ Properties:
caseExact: false
idcsCanonicalValueSourceFilter: attrName eq “countries” and attrValues.value eq “upper($(country))”
idcsCanonicalValueSourceResourceType: AllowedValue
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The country of this Addresses.
- Return type
str
- property formatted¶
Gets the formatted of this Addresses. The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The formatted of this Addresses.
- Return type
str
- property locality¶
Gets the locality of this Addresses. The city or locality component.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The locality of this Addresses.
- Return type
str
- property postal_code¶
Gets the postal_code of this Addresses. The zipcode or postal code component.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The postal_code of this Addresses.
- Return type
str
- property primary¶
Gets the primary of this Addresses. A Boolean value indicating the ‘primary’ or preferred attribute value for this attribute. 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 Addresses.
- Return type
bool
- property region¶
Gets the region of this Addresses. The state or region component.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The region of this Addresses.
- Return type
str
- property street_address¶
Gets the street_address of this Addresses. The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The street_address of this Addresses.
- Return type
str
- property type¶
[Required] Gets the type of this Addresses. A label indicating the attribute’s function; e.g., ‘work’ or ‘home’.
- 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”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The type of this Addresses.
- Return type
str