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-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.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 Admin Console 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 can 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 Details

  • Constructor Details

    • UserProfile

      public UserProfile()

  • Method Details

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • setAdditionalProperties

      public void setAdditionalProperties(Map<String,Object> additionalProperties)

    • city

      public UserProfile city(String city)

    • getCity

      @Nullable public String getCity()
      The city or locality of the User's address (`locality`)
      Returns:
      city

    • getCity_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCity_JsonNullable()

    • setCity_JsonNullable

      public void setCity_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> city)

    • setCity

      public void setCity(String city)

    • costCenter

      public UserProfile costCenter(String costCenter)

    • getCostCenter

      @Nullable public String getCostCenter()
      Name of the cost center assigned to a user
      Returns:
      costCenter

    • getCostCenter_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCostCenter_JsonNullable()

    • setCostCenter_JsonNullable

      public void setCostCenter_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> costCenter)

    • setCostCenter

      public void setCostCenter(String costCenter)

    • countryCode

      public UserProfile countryCode(String countryCode)

    • getCountryCode

      @Nullable public String getCountryCode()
      The country name component of the User's address (`country`). For validation, see [ISO 3166-1 alpha 2 \"short\" code format](https://datatracker.ietf.org/doc/html/draft-ietf-scim-core-schema-22#ref-ISO3166).
      Returns:
      countryCode

    • getCountryCode_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getCountryCode_JsonNullable()

    • setCountryCode_JsonNullable

      public void setCountryCode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> countryCode)

    • setCountryCode

      public void setCountryCode(String countryCode)

    • department

      public UserProfile department(String department)

    • getDepartment

      @Nullable public String getDepartment()
      Name of the User's department
      Returns:
      department

    • setDepartment

      public void setDepartment(String department)

    • displayName

      public UserProfile displayName(String displayName)

    • getDisplayName

      @Nullable public String getDisplayName()
      Name of the User suitable for display to end users
      Returns:
      displayName

    • getDisplayName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getDisplayName_JsonNullable()

    • setDisplayName_JsonNullable

      public void setDisplayName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> displayName)

    • setDisplayName

      public void setDisplayName(String displayName)

    • division

      public UserProfile division(String division)

    • getDivision

      @Nullable public String getDivision()
      Name of the User's division
      Returns:
      division

    • getDivision_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getDivision_JsonNullable()

    • setDivision_JsonNullable

      public void setDivision_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> division)

    • setDivision

      public void setDivision(String division)

    • email

      public UserProfile email(String email)

    • getEmail

      @Nullable public String getEmail()
      The primary email address of the user. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).
      Returns:
      email

    • setEmail

      public void setEmail(String email)

    • employeeNumber

      public UserProfile employeeNumber(String employeeNumber)

    • getEmployeeNumber

      @Nullable public String getEmployeeNumber()
      The organization or company assigned unique identifier for the user
      Returns:
      employeeNumber

    • setEmployeeNumber

      public void setEmployeeNumber(String employeeNumber)

    • firstName

      public UserProfile firstName(String firstName)

    • getFirstName

      @Nullable public String getFirstName()
      Given name of the User (`givenName`)
      Returns:
      firstName

    • getFirstName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getFirstName_JsonNullable()

    • setFirstName_JsonNullable

      public void setFirstName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> firstName)

    • setFirstName

      public void setFirstName(String firstName)

    • honorificPrefix

      public UserProfile honorificPrefix(String honorificPrefix)

    • getHonorificPrefix

      @Nullable public String getHonorificPrefix()
      Honorific prefix(es) of the user, or title in most Western languages
      Returns:
      honorificPrefix

    • getHonorificPrefix_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getHonorificPrefix_JsonNullable()

    • setHonorificPrefix_JsonNullable

      public void setHonorificPrefix_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> honorificPrefix)

    • setHonorificPrefix

      public void setHonorificPrefix(String honorificPrefix)

    • honorificSuffix

      public UserProfile honorificSuffix(String honorificSuffix)

    • getHonorificSuffix

      @Nullable public String getHonorificSuffix()
      Honorific suffix(es) of the User
      Returns:
      honorificSuffix

    • getHonorificSuffix_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getHonorificSuffix_JsonNullable()

    • setHonorificSuffix_JsonNullable

      public void setHonorificSuffix_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> honorificSuffix)

    • setHonorificSuffix

      public void setHonorificSuffix(String honorificSuffix)

    • lastName

      public UserProfile lastName(String lastName)

    • getLastName

      @Nullable public String getLastName()
      The family name of the User (`familyName`)
      Returns:
      lastName

    • getLastName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getLastName_JsonNullable()

    • setLastName_JsonNullable

      public void setLastName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> lastName)

    • setLastName

      public void setLastName(String lastName)

    • locale

      public UserProfile locale(String locale)

    • getLocale

      @Nullable public String 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

      public void setLocale(String locale)

    • login

      public UserProfile login(String login)

    • getLogin

      @Nullable public String 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). Every user within your Okta org must have a unique identifier for a login. This constraint applies to all users you import from other systems or applications such as Active Directory. Your organization is the top-level namespace to mix and match logins from all your connected applications or directories. Careful consideration of naming conventions for your login identifier will make it easier to onboard new applications in the future. Logins are not considered unique if they differ only in case and/or diacritical marks. If one of your users has a login of Isaac.Brock@example.com, there cannot be another user whose login is isaac.brock@example.com, nor isáàc.bröck@example.com. Okta has a default ambiguous name resolution policy for usernames that include @-signs. (By default, usernames must be formatted as email addresses and thus always include @-signs. You can remove that restriction using either the Admin Console or the Schemas API (opens new window).) Users can sign in with their non-qualified short name (for example: isaac.brock with username isaac.brock@example.com) as long as the short name is still unique within the organization. maxLength: 100
      Returns:
      login

    • setLogin

      public void setLogin(String login)

    • manager

      public UserProfile manager(String manager)

    • getManager

      @Nullable public String getManager()
      The `displayName` of the User's manager
      Returns:
      manager

    • getManager_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getManager_JsonNullable()

    • setManager_JsonNullable

      public void setManager_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> manager)

    • setManager

      public void setManager(String manager)

    • managerId

      public UserProfile managerId(String managerId)

    • getManagerId

      @Nullable public String getManagerId()
      The `id` of the User's manager
      Returns:
      managerId

    • getManagerId_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getManagerId_JsonNullable()

    • setManagerId_JsonNullable

      public void setManagerId_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> managerId)

    • setManagerId

      public void setManagerId(String managerId)

    • middleName

      public UserProfile middleName(String middleName)

    • getMiddleName

      @Nullable public String getMiddleName()
      The middle name of the user
      Returns:
      middleName

    • getMiddleName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getMiddleName_JsonNullable()

    • setMiddleName_JsonNullable

      public void setMiddleName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> middleName)

    • setMiddleName

      public void setMiddleName(String middleName)

    • mobilePhone

      public UserProfile mobilePhone(String mobilePhone)

    • getMobilePhone

      @Nullable public String getMobilePhone()
      The mobile phone number of the user
      Returns:
      mobilePhone

    • getMobilePhone_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getMobilePhone_JsonNullable()

    • setMobilePhone_JsonNullable

      public void setMobilePhone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> mobilePhone)

    • setMobilePhone

      public void setMobilePhone(String mobilePhone)

    • nickName

      public UserProfile nickName(String nickName)

    • getNickName

      @Nullable public String getNickName()
      The casual way to address the User in real life
      Returns:
      nickName

    • getNickName_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getNickName_JsonNullable()

    • setNickName_JsonNullable

      public void setNickName_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> nickName)

    • setNickName

      public void setNickName(String nickName)

    • organization

      public UserProfile organization(String organization)

    • getOrganization

      @Nullable public String getOrganization()
      Name of the the User's organization
      Returns:
      organization

    • getOrganization_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getOrganization_JsonNullable()

    • setOrganization_JsonNullable

      public void setOrganization_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> organization)

    • setOrganization

      public void setOrganization(String organization)

    • postalAddress

      public UserProfile postalAddress(String postalAddress)

    • getPostalAddress

      @Nullable public String getPostalAddress()
      Mailing address component of the User's address
      Returns:
      postalAddress

    • getPostalAddress_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getPostalAddress_JsonNullable()

    • setPostalAddress_JsonNullable

      public void setPostalAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> postalAddress)

    • setPostalAddress

      public void setPostalAddress(String postalAddress)

    • preferredLanguage

      public UserProfile preferredLanguage(String preferredLanguage)

    • getPreferredLanguage

      @Nullable public String getPreferredLanguage()
      The User's preferred written or spoken language. For validation, see [RFC 7231 Section 5.3.5](https://datatracker.ietf.org/doc/html/rfc7231#section-5.3.5).
      Returns:
      preferredLanguage

    • getPreferredLanguage_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getPreferredLanguage_JsonNullable()

    • setPreferredLanguage_JsonNullable

      public void setPreferredLanguage_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> preferredLanguage)

    • setPreferredLanguage

      public void setPreferredLanguage(String preferredLanguage)

    • primaryPhone

      public UserProfile primaryPhone(String primaryPhone)

    • getPrimaryPhone

      @Nullable public String getPrimaryPhone()
      The primary phone number of the User such as a home number
      Returns:
      primaryPhone

    • getPrimaryPhone_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getPrimaryPhone_JsonNullable()

    • setPrimaryPhone_JsonNullable

      public void setPrimaryPhone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> primaryPhone)

    • setPrimaryPhone

      public void setPrimaryPhone(String primaryPhone)

    • profileUrl

      public UserProfile profileUrl(String profileUrl)

    • getProfileUrl

      @Nullable public String getProfileUrl()
      The URL of the User's online profile. For example, a web page. See [URL](https://datatracker.ietf.org/doc/html/rfc1808).
      Returns:
      profileUrl

    • getProfileUrl_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getProfileUrl_JsonNullable()

    • setProfileUrl_JsonNullable

      public void setProfileUrl_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> profileUrl)

    • setProfileUrl

      public void setProfileUrl(String profileUrl)

    • secondEmail

      public UserProfile secondEmail(String secondEmail)

    • getSecondEmail

      @Nullable public String getSecondEmail()
      The secondary email address of the User typically used for account recovery. For validation, see [RFC 5322 Section 3.2.3](https://datatracker.ietf.org/doc/html/rfc5322#section-3.2.3).
      Returns:
      secondEmail

    • getSecondEmail_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getSecondEmail_JsonNullable()

    • setSecondEmail_JsonNullable

      public void setSecondEmail_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> secondEmail)

    • setSecondEmail

      public void setSecondEmail(String secondEmail)

    • state

      public UserProfile state(String state)

    • getState

      @Nullable public String getState()
      The state or region component of the User's address (`region`)
      Returns:
      state

    • getState_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getState_JsonNullable()

    • setState_JsonNullable

      public void setState_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> state)

    • setState

      public void setState(String state)

    • streetAddress

      public UserProfile streetAddress(String streetAddress)

    • getStreetAddress

      @Nullable public String getStreetAddress()
      The full street address component of the User's address
      Returns:
      streetAddress

    • getStreetAddress_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getStreetAddress_JsonNullable()

    • setStreetAddress_JsonNullable

      public void setStreetAddress_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> streetAddress)

    • setStreetAddress

      public void setStreetAddress(String streetAddress)

    • timezone

      public UserProfile timezone(String timezone)

    • getTimezone

      @Nullable public String getTimezone()
      The User's time zone
      Returns:
      timezone

    • getTimezone_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTimezone_JsonNullable()

    • setTimezone_JsonNullable

      public void setTimezone_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> timezone)

    • setTimezone

      public void setTimezone(String timezone)

    • title

      public UserProfile title(String title)

    • getTitle

      @Nullable public String getTitle()
      The User's title, such as Vice President
      Returns:
      title

    • getTitle_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getTitle_JsonNullable()

    • setTitle_JsonNullable

      public void setTitle_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> title)

    • setTitle

      public void setTitle(String title)

    • userType

      public UserProfile userType(String userType)

    • getUserType

      @Nullable public String getUserType()
      The property used to describe the organization-to-user relationship, such as employee or contractor
      Returns:
      userType

    • getUserType_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getUserType_JsonNullable()

    • setUserType_JsonNullable

      public void setUserType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> userType)

    • setUserType

      public void setUserType(String userType)

    • zipCode

      public UserProfile zipCode(String zipCode)

    • getZipCode

      @Nullable public String getZipCode()
      The ZIP code or postal code component of the User's address (`postalCode`)
      Returns:
      zipCode

    • getZipCode_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getZipCode_JsonNullable()

    • setZipCode_JsonNullable

      public void setZipCode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> zipCode)

    • setZipCode

      public void setZipCode(String zipCode)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object