• Home
• com.okta.sdk
• okta-sdk-api
• 20.0.0
• source code
• UserProfile.md

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

docs.UserProfile.md Maven / Gradle / Ivy

# UserProfile

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.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**city** | **String** | The city or locality of the User's address (`locality`) |  [optional] |
|**costCenter** | **String** | Name of the cost center assigned to a user |  [optional] |
|**countryCode** | **String** | 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). |  [optional] |
|**department** | **String** | Name of the User's department |  [optional] |
|**displayName** | **String** | Name of the User suitable for display to end users |  [optional] |
|**division** | **String** | Name of the User's division |  [optional] |
|**email** | **String** | 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). |  [optional] |
|**employeeNumber** | **String** | The organization or company assigned unique identifier for the user |  [optional] |
|**firstName** | **String** | Given name of the User (`givenName`) |  [optional] |
|**honorificPrefix** | **String** | Honorific prefix(es) of the user, or title in most Western languages |  [optional] |
|**honorificSuffix** | **String** | Honorific suffix(es) of the User |  [optional] |
|**lastName** | **String** | The family name of the User (`familyName`) |  [optional] |
|**locale** | **String** | 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. |  [optional] |
|**login** | **String** | 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 [email protected], there cannot be another user whose login is [email protected], nor isáàc.brö[email protected].  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 [email protected]) as long as the short name is still unique within the organization. maxLength: 100 |  [optional] |
|**manager** | **String** | The `displayName` of the User's manager |  [optional] |
|**managerId** | **String** | The `id` of the User's manager |  [optional] |
|**middleName** | **String** | The middle name of the user |  [optional] |
|**mobilePhone** | **String** | The mobile phone number of the user |  [optional] |
|**nickName** | **String** | The casual way to address the User in real life |  [optional] |
|**organization** | **String** | Name of the the User's organization |  [optional] |
|**postalAddress** | **String** | Mailing address component of the User's address |  [optional] |
|**preferredLanguage** | **String** | 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). |  [optional] |
|**primaryPhone** | **String** | The primary phone number of the User such as a home number |  [optional] |
|**profileUrl** | **String** | The URL of the User's online profile. For example, a web page. See [URL](https://datatracker.ietf.org/doc/html/rfc1808). |  [optional] |
|**secondEmail** | **String** | 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). |  [optional] |
|**state** | **String** | The state or region component of the User's address (`region`) |  [optional] |
|**streetAddress** | **String** | The full street address component of the User's address |  [optional] |
|**timezone** | **String** | The User's time zone |  [optional] |
|**title** | **String** | The User's title, such as Vice President |  [optional] |
|**userType** | **String** | The property used to describe the organization-to-user relationship, such as employee or contractor |  [optional] |
|**zipCode** | **String** | The ZIP code or postal code component of the User's address (`postalCode`) |  [optional] |


## Implemented Interfaces

* Serializable