All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • docs.UserSchemaBaseProperties.md Maven / Gradle / Ivy

    Go to download

    The Okta Java SDK API .jar provides a Java API that your code can use to make calls to the Okta API. This .jar is the only compile-time dependency within the Okta SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

    There is a newer version: 21.0.0
    Show newest version
    

# UserSchemaBaseProperties


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**city** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | City or locality component of the User's address (`locality`) |  [optional] |
|**costCenter** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Name of a cost center assigned to the User |  [optional] |
|**countryCode** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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). |  [optional] |
|**department** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Name of the User's department |  [optional] |
|**displayName** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Name of the User, suitable for display to end Users |  [optional] |
|**division** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Name of the User's division |  [optional] |
|**email** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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). |  [optional] |
|**employeeNumber** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Organization or company assigned unique identifier for the User |  [optional] |
|**firstName** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Given name of the User (`givenName`) |  [optional] |
|**honorificPrefix** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Honorific prefix(es) of the User or title in most Western languages |  [optional] |
|**honorificSuffix** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Honorific suffix(es) of the User |  [optional] |
|**lastName** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Family name of the User (`familyName`) |  [optional] |
|**locale** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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. |  [optional] |
|**manager** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | The `displayName` of the User's manager |  [optional] |
|**managerId** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | The `id` of the User's manager |  [optional] |
|**middleName** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Middle name(s) of the User |  [optional] |
|**mobilePhone** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Mobile phone number of the User |  [optional] |
|**nickName** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Casual way to address the User in real life |  [optional] |
|**organization** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Name of the User's organization |  [optional] |
|**postalAddress** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Mailing address component of the User's address |  [optional] |
|**preferredLanguage** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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). |  [optional] |
|**primaryPhone** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Primary phone number of the User, such as home number |  [optional] |
|**profileUrl** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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). |  [optional] |
|**secondEmail** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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). |  [optional] |
|**state** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | State or region component of the User's address (`region`) |  [optional] |
|**streetAddress** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | Full street address component of the User's address |  [optional] |
|**timezone** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | User's time zone. This property is formatted according to the [IANA Time Zone database format](https://tools.ietf.org/html/rfc6557). |  [optional] |
|**title** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | User's title, such as \"Vice President\" |  [optional] |
|**userType** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | 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. |  [optional] |
|**zipCode** | [**UserSchemaAttribute**](UserSchemaAttribute.md) | ZIP code or postal code component of the User's address (`postalCode`) |  [optional] |


## Implemented Interfaces

* Serializable




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy