Okta.Sdk.Model.UserSchemaBasePropertiesFirstName
October 28, 2025 ยท View on GitHub
Given name of the user (givenName)
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| Default | Object | If specified, assigns the value as the default value for the custom attribute. This is a nullable property. If you don't specify a value for this custom attribute during user creation or update, the `default` is used instead of setting the value to `null` or empty. | [optional] |
| Description | string | Description of the property | [optional] |
| Enum | List<Object> | 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] |
| 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] |
| Items | UserSchemaAttributeItems | [optional] | |
| Master | GroupSchemaAttributeMaster | [optional] | |
| MaxLength | int? | Maximum character length of a string property | [optional] |
| MinLength | int? | Minimum character length of a string property | [optional] |
| Mutability | UserSchemaAttributeMutabilityString | Defines the mutability of the property | [optional] |
| OneOf | List<UserSchemaAttributeEnum> | Non-empty array of valid JSON schemas. The `oneOf` key is only supported in conjunction with `enum` and provides a mechanism to return a display name for the `enum` value.<br> Each schema has the following format: ``` { "const": "enumValue", "title": "display name" } ``` When `enum` is used in conjunction with `oneOf`, you must keep the set of enumerated values and their order.<br> For example: ``` "enum": ["S","M","L","XL"], "oneOf": [ {"const": "S", "title": "Small"}, {"const": "M", "title": "Medium"}, {"const": "L", "title": "Large"}, {"const": "XL", "title": "Extra Large"} ] ``` | [optional] |
| Pattern | string | For `string` property types, specifies the regular expression used to validate the property | [optional] |
| Permissions | List<UserSchemaAttributePermission> | Access control permissions for the property | [optional] |
| Required | bool? | 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 | bool? | Determines whether property values must be unique | [optional] |