docs.UserSchemaAttribute.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of okta-sdk-api Show documentation

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.

The newest version!



# UserSchemaAttribute


## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**description** | **String** | Description of the property |  [optional] |
|**_enum** | **List<String>** | Enumerated value of the property.  The value of the property is limited to one of the values specified in the enum definition. The list of values for the enum must consist of unique elements. |  [optional] |
|**items** | [**UserSchemaAttributeItems**](UserSchemaAttributeItems.md) |  |  [optional] |
|**externalName** | **String** | Name of the property as it exists in an external application  **NOTE**: When you add a custom property, only Identity Provider app user schemas require `externalName` to be included in the request body. If an existing custom Identity Provider app user schema property has an empty `externalName`, requests aren't allowed to update other properties until the `externalName` is defined. |  [optional] |
|**externalNamespace** | **String** | Namespace from the external application |  [optional] |
|**format** | **UserSchemaAttributeFormat** | Identifies the type of data represented by the string |  [optional] |
|**master** | [**UserSchemaAttributeMaster**](UserSchemaAttributeMaster.md) | Identifies where the property is mastered |  [optional] |
|**maxLength** | **Integer** | Maximum character length of a string property |  [optional] |
|**minLength** | **Integer** | Minimum character length of a string property |  [optional] |
|**mutability** | **UserSchemaAttributeMutabilityString** | Defines the mutability of the property |  [optional] |
|**oneOf** | [**List<UserSchemaAttributeEnum>**](UserSchemaAttributeEnum.md) | Non-empty array of valid JSON schemas.  Okta only supports `oneOf` for specifying display names for an `enum`. Each schema has the following format:    ```     {       \"const\": \"enumValue\",       \"title\": \"display name\"     }   ```json  When `enum` is used in conjunction with `oneOf`, you must keep the set of enumerated values and their order.    ```     {\"enum\": [\"S\",\"M\",\"L\",\"XL\"],       \"oneOf\": [         {\"const\": \"S\", \"title\": \"Small\"},         {\"const\": \"M\", \"title\": \"Medium\"},         {\"const\": \"L\", \"title\": \"Large\"},         {\"const\": \"XL\", \"title\": \"Extra Large\"}       ]     }   ```json  The `oneOf` key is only supported in conjunction with `enum` and provides a mechanism to return a display name for the `enum` value. |  [optional] |
|**pattern** | **String** | For `string` property types, specifies the regular expression used to validate the property |  [optional] |
|**permissions** | [**List<UserSchemaAttributePermission>**](UserSchemaAttributePermission.md) | Access control permissions for the property |  [optional] |
|**required** | **Boolean** | Determines whether the property is required |  [optional] |
|**scope** | **UserSchemaAttributeScope** |  |  [optional] |
|**title** | **String** | User-defined display name for the property |  [optional] |
|**type** | **UserSchemaAttributeType** | Type of property |  [optional] |
|**unique** | **String** |  |  [optional] |


## Implemented Interfaces

* Serializable