Package com.okta.sdk.resource.model
Class UserSchemaBaseProperties
java.lang.Object
com.okta.sdk.resource.model.UserSchemaBaseProperties
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
comments="Generator version: 7.8.0")
public class UserSchemaBaseProperties
extends Object
implements Serializable
UserSchemaBaseProperties
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncity
(UserSchemaAttribute city) costCenter
(UserSchemaAttribute costCenter) countryCode
(UserSchemaAttribute countryCode) department
(UserSchemaAttribute department) displayName
(UserSchemaAttribute displayName) division
(UserSchemaAttribute division) email
(UserSchemaAttribute email) employeeNumber
(UserSchemaAttribute employeeNumber) boolean
firstName
(UserSchemaAttribute firstName) getCity()
City or locality component of the User's address (`locality`)Name of a cost center assigned to the UserCountry name component of the User's address (`country`.) This property uses [ISO 3166-1 alpha 2 \"short\" code format](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166).Name of the User's departmentName of the User, suitable for display to end UsersName of the User's divisiongetEmail()
Primary email address of the User.Organization or company assigned unique identifier for the UserGiven name of the User (`givenName`)Honorific prefix(es) of the User or title in most Western languagesHonorific suffix(es) of the UserFamily name of the User (`familyName`)User's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.getLogin()
Unique identifier for the User (`username`) The login property is validated according to its pattern attribute, which is a string.The `displayName` of the User's managerThe `id` of the User's managerMiddle name(s) of the UserMobile phone number of the UserCasual way to address the User in real lifeName of the User's organizationMailing address component of the User's addressUser's preferred written or spoken languages.Primary phone number of the User, such as home numberURL of the User's online Profile (for example, a web page.) This property is formatted according to the [Relative Uniform Resource Locators specification](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166).Secondary email address of the User typically used for account recovery.getState()
State or region component of the User's address (`region`)Full street address component of the User's addressUser's time zone.getTitle()
User's title, such as \"Vice President\"Used to describe the organization to the User relationship such as \"Employee\" or \"Contractor\".ZIP code or postal code component of the User's address (`postalCode`)int
hashCode()
honorificPrefix
(UserSchemaAttribute honorificPrefix) honorificSuffix
(UserSchemaAttribute honorificSuffix) lastName
(UserSchemaAttribute lastName) locale
(UserSchemaAttribute locale) login
(UserSchemaAttribute login) manager
(UserSchemaAttribute manager) managerId
(UserSchemaAttribute managerId) middleName
(UserSchemaAttribute middleName) mobilePhone
(UserSchemaAttribute mobilePhone) nickName
(UserSchemaAttribute nickName) organization
(UserSchemaAttribute organization) postalAddress
(UserSchemaAttribute postalAddress) preferredLanguage
(UserSchemaAttribute preferredLanguage) primaryPhone
(UserSchemaAttribute primaryPhone) profileUrl
(UserSchemaAttribute profileUrl) secondEmail
(UserSchemaAttribute secondEmail) void
setCity
(UserSchemaAttribute city) void
setCostCenter
(UserSchemaAttribute costCenter) void
setCountryCode
(UserSchemaAttribute countryCode) void
setDepartment
(UserSchemaAttribute department) void
setDisplayName
(UserSchemaAttribute displayName) void
setDivision
(UserSchemaAttribute division) void
setEmail
(UserSchemaAttribute email) void
setEmployeeNumber
(UserSchemaAttribute employeeNumber) void
setFirstName
(UserSchemaAttribute firstName) void
setHonorificPrefix
(UserSchemaAttribute honorificPrefix) void
setHonorificSuffix
(UserSchemaAttribute honorificSuffix) void
setLastName
(UserSchemaAttribute lastName) void
setLocale
(UserSchemaAttribute locale) void
setLogin
(UserSchemaAttribute login) void
setManager
(UserSchemaAttribute manager) void
setManagerId
(UserSchemaAttribute managerId) void
setMiddleName
(UserSchemaAttribute middleName) void
setMobilePhone
(UserSchemaAttribute mobilePhone) void
setNickName
(UserSchemaAttribute nickName) void
setOrganization
(UserSchemaAttribute organization) void
setPostalAddress
(UserSchemaAttribute postalAddress) void
setPreferredLanguage
(UserSchemaAttribute preferredLanguage) void
setPrimaryPhone
(UserSchemaAttribute primaryPhone) void
setProfileUrl
(UserSchemaAttribute profileUrl) void
setSecondEmail
(UserSchemaAttribute secondEmail) void
setState
(UserSchemaAttribute state) void
setStreetAddress
(UserSchemaAttribute streetAddress) void
setTimezone
(UserSchemaAttribute timezone) void
setTitle
(UserSchemaAttribute title) void
setUserType
(UserSchemaAttribute userType) void
setZipCode
(UserSchemaAttribute zipCode) state
(UserSchemaAttribute state) streetAddress
(UserSchemaAttribute streetAddress) timezone
(UserSchemaAttribute timezone) title
(UserSchemaAttribute title) toString()
userType
(UserSchemaAttribute userType) zipCode
(UserSchemaAttribute zipCode)
-
Field Details
-
JSON_PROPERTY_CITY
- See Also:
-
JSON_PROPERTY_COST_CENTER
- See Also:
-
JSON_PROPERTY_COUNTRY_CODE
- See Also:
-
JSON_PROPERTY_DEPARTMENT
- See Also:
-
JSON_PROPERTY_DISPLAY_NAME
- See Also:
-
JSON_PROPERTY_DIVISION
- See Also:
-
JSON_PROPERTY_EMAIL
- See Also:
-
JSON_PROPERTY_EMPLOYEE_NUMBER
- See Also:
-
JSON_PROPERTY_FIRST_NAME
- See Also:
-
JSON_PROPERTY_HONORIFIC_PREFIX
- See Also:
-
JSON_PROPERTY_HONORIFIC_SUFFIX
- See Also:
-
JSON_PROPERTY_LAST_NAME
- See Also:
-
JSON_PROPERTY_LOCALE
- See Also:
-
JSON_PROPERTY_LOGIN
- See Also:
-
JSON_PROPERTY_MANAGER
- See Also:
-
JSON_PROPERTY_MANAGER_ID
- See Also:
-
JSON_PROPERTY_MIDDLE_NAME
- See Also:
-
JSON_PROPERTY_MOBILE_PHONE
- See Also:
-
JSON_PROPERTY_NICK_NAME
- See Also:
-
JSON_PROPERTY_ORGANIZATION
- See Also:
-
JSON_PROPERTY_POSTAL_ADDRESS
- See Also:
-
JSON_PROPERTY_PREFERRED_LANGUAGE
- See Also:
-
JSON_PROPERTY_PRIMARY_PHONE
- See Also:
-
JSON_PROPERTY_PROFILE_URL
- See Also:
-
JSON_PROPERTY_SECOND_EMAIL
- See Also:
-
JSON_PROPERTY_STATE
- See Also:
-
JSON_PROPERTY_STREET_ADDRESS
- See Also:
-
JSON_PROPERTY_TIMEZONE
- See Also:
-
JSON_PROPERTY_TITLE
- See Also:
-
JSON_PROPERTY_USER_TYPE
- See Also:
-
JSON_PROPERTY_ZIP_CODE
- See Also:
-
-
Constructor Details
-
UserSchemaBaseProperties
public UserSchemaBaseProperties()
-
-
Method Details
-
city
-
getCity
City or locality component of the User's address (`locality`)- Returns:
- city
-
setCity
-
costCenter
-
getCostCenter
Name of a cost center assigned to the User- Returns:
- costCenter
-
setCostCenter
-
countryCode
-
getCountryCode
Country name component of the User's address (`country`.) This property uses [ISO 3166-1 alpha 2 \"short\" code format](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166).- Returns:
- countryCode
-
setCountryCode
-
department
-
getDepartment
Name of the User's department- Returns:
- department
-
setDepartment
-
displayName
-
getDisplayName
Name of the User, suitable for display to end Users- Returns:
- displayName
-
setDisplayName
-
division
-
getDivision
Name of the User's division- Returns:
- division
-
setDivision
-
email
-
getEmail
Primary email address of the User. This property is formatted according to [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).- Returns:
-
setEmail
-
employeeNumber
-
getEmployeeNumber
Organization or company assigned unique identifier for the User- Returns:
- employeeNumber
-
setEmployeeNumber
-
firstName
-
getFirstName
Given name of the User (`givenName`)- Returns:
- firstName
-
setFirstName
-
honorificPrefix
-
getHonorificPrefix
Honorific prefix(es) of the User or title in most Western languages- Returns:
- honorificPrefix
-
setHonorificPrefix
-
honorificSuffix
-
getHonorificSuffix
Honorific suffix(es) of the User- Returns:
- honorificSuffix
-
setHonorificSuffix
-
lastName
-
getLastName
Family name of the User (`familyName`)- Returns:
- lastName
-
setLastName
-
locale
-
getLocale
User's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on. A locale value is a concatenation of the ISO 639-1 two-letter language code, an underscore, and the ISO 3166-1 two-letter country code. For example: `en_US` specifies the language English and country US. This value is `en_US` by default.- Returns:
- locale
-
setLocale
-
login
-
getLogin
Unique identifier for the User (`username`) The login property is validated according to its pattern attribute, which is a string. By default, the attribute is null. When the attribute is null, the username is required to be formatted as an email address as defined by [RFC 6531 Section 3.3](http://tools.ietf.org/html/rfc6531#section-3.3). The pattern can be set through the API to one of the following forms. (The Admin Console provides access to the same forms.) * A login pattern of `\".+\"` indicates that there is no restriction on usernames. Any non-empty, unique value is permitted, and the minimum length of five isn't enforced. In this case, usernames don't need to include the `@` character. If a name does include `@`, the portion ahead of the `@` can be used for logging in, provided it identifies a unique User within the org. * A login pattern of the form `\"[...]+\"` indicates that usernames must only contain characters from the set given between the brackets. The enclosing brackets and final `+` are required for this form. Character ranges can be indicated using hyphens. To include the hyphen itself in the allowed set, the hyphen must appear first. Any characters in the set except the hyphen, a-z, A-Z, and 0-9 must be preceded by a backslash (`\\`). For example, `\"[a-z13579\\.]+\"` would restrict usernames to lowercase letters, odd digits, and periods, while `\"[-a-zA-Z0-9]+\"` would allow basic alphanumeric characters and hyphens.- Returns:
- login
-
setLogin
-
manager
-
getManager
The `displayName` of the User's manager- Returns:
- manager
-
setManager
-
managerId
-
getManagerId
The `id` of the User's manager- Returns:
- managerId
-
setManagerId
-
middleName
-
getMiddleName
Middle name(s) of the User- Returns:
- middleName
-
setMiddleName
-
mobilePhone
-
getMobilePhone
Mobile phone number of the User- Returns:
- mobilePhone
-
setMobilePhone
-
nickName
-
getNickName
Casual way to address the User in real life- Returns:
- nickName
-
setNickName
-
organization
-
getOrganization
Name of the User's organization- Returns:
- organization
-
setOrganization
-
postalAddress
-
getPostalAddress
Mailing address component of the User's address- Returns:
- postalAddress
-
setPostalAddress
-
preferredLanguage
-
getPreferredLanguage
User's preferred written or spoken languages. This property is formatted according to [RFC 7231 Section 5.3.5](https://tools.ietf.org/html/rfc7231#section-5.3.5).- Returns:
- preferredLanguage
-
setPreferredLanguage
-
-
getPrimaryPhone
Primary phone number of the User, such as home number- Returns:
- primaryPhone
-
setPrimaryPhone
-
profileUrl
-
getProfileUrl
URL of the User's online Profile (for example, a web page.) This property is formatted according to the [Relative Uniform Resource Locators specification](https://tools.ietf.org/html/draft-ietf-scim-core-schema-22#ref-ISO3166).- Returns:
- profileUrl
-
setProfileUrl
-
secondEmail
-
getSecondEmail
Secondary email address of the User typically used for account recovery. This property is formatted according to [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).- Returns:
- secondEmail
-
setSecondEmail
-
state
-
getState
State or region component of the User's address (`region`)- Returns:
- state
-
setState
-
streetAddress
-
getStreetAddress
Full street address component of the User's address- Returns:
- streetAddress
-
setStreetAddress
-
timezone
-
getTimezone
User's time zone. This property is formatted according to the [IANA Time Zone database format](https://tools.ietf.org/html/rfc6557).- Returns:
- timezone
-
setTimezone
-
title
-
getTitle
User's title, such as \"Vice President\"- Returns:
- title
-
setTitle
-
userType
-
getUserType
Used to describe the organization to the User relationship such as \"Employee\" or \"Contractor\". **Note:** The `userType` field is an arbitrary string value and isn't related to the newer [User Types](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UserType/) feature.- Returns:
- userType
-
setUserType
-
zipCode
-
getZipCode
ZIP code or postal code component of the User's address (`postalCode`)- Returns:
- zipCode
-
setZipCode
-
equals
-
hashCode
public int hashCode() -
toString
-