Okta.Sdk.Model.UserProfile
October 22, 2025 · View on GitHub
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. 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 for login. You can use the Profile Editor in the Admin Console or the Schemas API 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 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 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. | [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] |
| string | The primary email address of the user. For validation, see RFC 5322 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. 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. 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 | [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. | [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. | [optional] |
| SecondEmail | string | The secondary email address of the user typically used for account recovery. For validation, see RFC 5322 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] |