Package com.okta.sdk.resource.model
Class UserProfile
java.lang.Object
com.okta.sdk.resource.model.UserProfile
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class UserProfile
extends Object
implements Serializable
Specifies the default and custom profile properties for a user. The default user profile is based on the [System for
Cross-domain Identity Management: Core Schema](https://datatracker.ietf.org/doc/html/rfc7643). The only permitted
customizations of the default profile are to update permissions, change whether the `firstName` and
`lastName` properties are nullable, and specify a
[pattern](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation) for `login`. You
can use the Profile Editor in the administrator UI or the [Schemas
API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to make
schema modifications. You can extend user profiles with custom properties. You must first add the custom property to
the user profile schema before you reference it. You can use the Profile Editor in the Admin console or the [Schemas
API](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/UISchema/#tag/UISchema) to manage
schema extensions. Custom attributes may contain HTML tags. It's the client's responsibility to escape or
encode this data before displaying it. Use
[best-practices](https://cheatsheetseries.owasp.org/cheatsheets/Cross_Site_Scripting_Prevention_Cheat_Sheet.html) to
prevent cross-site scripting.
- See Also:
-
Field Summary
FieldsModifier 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
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncostCenter
(String costCenter) countryCode
(String countryCode) department
(String department) displayName
(String displayName) employeeNumber
(String employeeNumber) boolean
getCity()
The city or locality of the user's address (`locality`)org.openapitools.jackson.nullable.JsonNullable
<String> Name of the cost center assigned to a userorg.openapitools.jackson.nullable.JsonNullable
<String> The country name component of the user's address (`country`)org.openapitools.jackson.nullable.JsonNullable
<String> Name of the user's departmentName of the user suitable for display to end usersorg.openapitools.jackson.nullable.JsonNullable
<String> Name of the user's divisionorg.openapitools.jackson.nullable.JsonNullable
<String> getEmail()
The primary email address of the user.The organization or company assigned unique identifier for the userGiven name of the user (`givenName`)org.openapitools.jackson.nullable.JsonNullable
<String> Honorific prefix(es) of the user, or title in most Western languagesorg.openapitools.jackson.nullable.JsonNullable
<String> Honorific suffix(es) of the userorg.openapitools.jackson.nullable.JsonNullable
<String> The family name of the user (`familyName`)org.openapitools.jackson.nullable.JsonNullable
<String> The user's default location for purposes of localizing items such as currency, date time format, numerical representations, and so on.getLogin()
The unique identifier for the user (`username`).The `displayName` of the user's managerorg.openapitools.jackson.nullable.JsonNullable
<String> The `id` of the user's managerorg.openapitools.jackson.nullable.JsonNullable
<String> The middle name of the userorg.openapitools.jackson.nullable.JsonNullable
<String> The mobile phone number of the userorg.openapitools.jackson.nullable.JsonNullable
<String> The casual way to address the user in real lifeorg.openapitools.jackson.nullable.JsonNullable
<String> Name of the the user's organizationorg.openapitools.jackson.nullable.JsonNullable
<String> Mailing address component of the user's addressorg.openapitools.jackson.nullable.JsonNullable
<String> The user's preferred written or spoken languageorg.openapitools.jackson.nullable.JsonNullable
<String> The primary phone number of the user such as a home numberorg.openapitools.jackson.nullable.JsonNullable
<String> The URL of the user's online profile.org.openapitools.jackson.nullable.JsonNullable
<String> The secondary email address of the user typically used for account recoveryorg.openapitools.jackson.nullable.JsonNullable
<String> getState()
The state or region component of the user's address (`region`)org.openapitools.jackson.nullable.JsonNullable
<String> The full street address component of the user's addressorg.openapitools.jackson.nullable.JsonNullable
<String> The user's time zoneorg.openapitools.jackson.nullable.JsonNullable
<String> getTitle()
The user's title, such as Vice Presidentorg.openapitools.jackson.nullable.JsonNullable
<String> The property used to describe the organization-to-user relationship, such as employee or contractororg.openapitools.jackson.nullable.JsonNullable
<String> The ZIP code or postal code component of the user's address (`postalCode`)org.openapitools.jackson.nullable.JsonNullable
<String> int
hashCode()
honorificPrefix
(String honorificPrefix) honorificSuffix
(String honorificSuffix) middleName
(String middleName) mobilePhone
(String mobilePhone) organization
(String organization) postalAddress
(String postalAddress) preferredLanguage
(String preferredLanguage) primaryPhone
(String primaryPhone) profileUrl
(String profileUrl) secondEmail
(String secondEmail) void
setAdditionalProperties
(Map<String, Object> additionalProperties) void
void
setCity_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> city) void
setCostCenter
(String costCenter) void
setCostCenter_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> costCenter) void
setCountryCode
(String countryCode) void
setCountryCode_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> countryCode) void
setDepartment
(String department) void
setDisplayName
(String displayName) void
setDisplayName_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> displayName) void
setDivision
(String division) void
setDivision_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> division) void
void
setEmployeeNumber
(String employeeNumber) void
setFirstName
(String firstName) void
setFirstName_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> firstName) void
setHonorificPrefix
(String honorificPrefix) void
setHonorificPrefix_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> honorificPrefix) void
setHonorificSuffix
(String honorificSuffix) void
setHonorificSuffix_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> honorificSuffix) void
setLastName
(String lastName) void
setLastName_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> lastName) void
void
void
setManager
(String manager) void
setManager_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> manager) void
setManagerId
(String managerId) void
setManagerId_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> managerId) void
setMiddleName
(String middleName) void
setMiddleName_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> middleName) void
setMobilePhone
(String mobilePhone) void
setMobilePhone_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> mobilePhone) void
setNickName
(String nickName) void
setNickName_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> nickName) void
setOrganization
(String organization) void
setOrganization_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> organization) void
setPostalAddress
(String postalAddress) void
setPostalAddress_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> postalAddress) void
setPreferredLanguage
(String preferredLanguage) void
setPreferredLanguage_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> preferredLanguage) void
setPrimaryPhone
(String primaryPhone) void
setPrimaryPhone_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> primaryPhone) void
setProfileUrl
(String profileUrl) void
setProfileUrl_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> profileUrl) void
setSecondEmail
(String secondEmail) void
setSecondEmail_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> secondEmail) void
void
setState_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> state) void
setStreetAddress
(String streetAddress) void
setStreetAddress_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> streetAddress) void
setTimezone
(String timezone) void
setTimezone_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> timezone) void
void
setTitle_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> title) void
setUserType
(String userType) void
setUserType_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> userType) void
setZipCode
(String zipCode) void
setZipCode_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> zipCode) streetAddress
(String streetAddress) toString()
-
Field Details
-
additionalProperties
-
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
-
UserProfile
public UserProfile()
-
-
Method Details
-
getAdditionalProperties
-
setAdditionalProperties
-
city
-
getCity
-
getCity_JsonNullable
-
setCity_JsonNullable
-
setCity
-
costCenter
-
getCostCenter
-
getCostCenter_JsonNullable
-
setCostCenter_JsonNullable
public void setCostCenter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> costCenter) -
setCostCenter
-
countryCode
-
getCountryCode
-
getCountryCode_JsonNullable
-
setCountryCode_JsonNullable
public void setCountryCode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> countryCode) -
setCountryCode
-
department
-
getDepartment
-
setDepartment
-
displayName
-
getDisplayName
-
getDisplayName_JsonNullable
-
setDisplayName_JsonNullable
public void setDisplayName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> displayName) -
setDisplayName
-
division
-
getDivision
-
getDivision_JsonNullable
-
setDivision_JsonNullable
public void setDivision_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> division) -
setDivision
-
email
-
getEmail
-
setEmail
-
employeeNumber
-
getEmployeeNumber
-
setEmployeeNumber
-
firstName
-
getFirstName
-
getFirstName_JsonNullable
-
setFirstName_JsonNullable
public void setFirstName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> firstName) -
setFirstName
-
honorificPrefix
-
getHonorificPrefix
-
getHonorificPrefix_JsonNullable
-
setHonorificPrefix_JsonNullable
public void setHonorificPrefix_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> honorificPrefix) -
setHonorificPrefix
-
honorificSuffix
-
getHonorificSuffix
-
getHonorificSuffix_JsonNullable
-
setHonorificSuffix_JsonNullable
public void setHonorificSuffix_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> honorificSuffix) -
setHonorificSuffix
-
lastName
-
getLastName
-
getLastName_JsonNullable
-
setLastName_JsonNullable
public void setLastName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> lastName) -
setLastName
-
locale
-
getLocale
The 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
The unique identifier for the user (`username`). For validation, see [Login pattern validation](https://developer.okta.com/docs/reference/api/schemas/#login-pattern-validation). See also [Okta login](https://developer.okta.com/docs/reference/api/users/#okta-login).- Returns:
- login
-
setLogin
-
manager
-
getManager
-
getManager_JsonNullable
-
setManager_JsonNullable
-
setManager
-
managerId
-
getManagerId
-
getManagerId_JsonNullable
-
setManagerId_JsonNullable
public void setManagerId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> managerId) -
setManagerId
-
middleName
-
getMiddleName
-
getMiddleName_JsonNullable
-
setMiddleName_JsonNullable
public void setMiddleName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> middleName) -
setMiddleName
-
mobilePhone
-
getMobilePhone
-
getMobilePhone_JsonNullable
-
setMobilePhone_JsonNullable
public void setMobilePhone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> mobilePhone) -
setMobilePhone
-
nickName
-
getNickName
-
getNickName_JsonNullable
-
setNickName_JsonNullable
public void setNickName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> nickName) -
setNickName
-
organization
-
getOrganization
-
getOrganization_JsonNullable
-
setOrganization_JsonNullable
public void setOrganization_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> organization) -
setOrganization
-
postalAddress
-
getPostalAddress
-
getPostalAddress_JsonNullable
-
setPostalAddress_JsonNullable
public void setPostalAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> postalAddress) -
setPostalAddress
-
preferredLanguage
-
getPreferredLanguage
-
getPreferredLanguage_JsonNullable
-
setPreferredLanguage_JsonNullable
public void setPreferredLanguage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> preferredLanguage) -
setPreferredLanguage
-
-
getPrimaryPhone
-
getPrimaryPhone_JsonNullable
-
setPrimaryPhone_JsonNullable
public void setPrimaryPhone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> primaryPhone) -
setPrimaryPhone
-
profileUrl
-
getProfileUrl
-
getProfileUrl_JsonNullable
-
setProfileUrl_JsonNullable
public void setProfileUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> profileUrl) -
setProfileUrl
-
secondEmail
-
getSecondEmail
-
getSecondEmail_JsonNullable
-
setSecondEmail_JsonNullable
public void setSecondEmail_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> secondEmail) -
setSecondEmail
-
state
-
getState
-
getState_JsonNullable
-
setState_JsonNullable
-
setState
-
streetAddress
-
getStreetAddress
-
getStreetAddress_JsonNullable
-
setStreetAddress_JsonNullable
public void setStreetAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> streetAddress) -
setStreetAddress
-
timezone
-
getTimezone
-
getTimezone_JsonNullable
-
setTimezone_JsonNullable
public void setTimezone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> timezone) -
setTimezone
-
title
-
getTitle
-
getTitle_JsonNullable
-
setTitle_JsonNullable
-
setTitle
-
userType
-
getUserType
-
getUserType_JsonNullable
-
setUserType_JsonNullable
public void setUserType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> userType) -
setUserType
-
zipCode
-
getZipCode
-
getZipCode_JsonNullable
-
setZipCode_JsonNullable
-
setZipCode
-
equals
-
hashCode
-
toString
-