Package com.okta.sdk.resource.model
Class UserSchemaAttribute
java.lang.Object
com.okta.sdk.resource.model.UserSchemaAttribute
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
comments="Generator version: 7.8.0")
public class UserSchemaAttribute
extends Object
implements Serializable
UserSchemaAttribute
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescription_enum
(List<GroupSchemaAttributeEnumInner> _enum) addenumItem
(GroupSchemaAttributeEnumInner _enumItem) addoneOfItem
(UserSchemaAttributeEnum oneOfItem) addpermissionsItem
(UserSchemaAttributePermission permissionsItem) description
(String description) boolean
externalName
(String externalName) externalNamespace
(String externalNamespace) format
(UserSchemaAttributeFormat format) Description of the propertygetEnum()
Enumerated value of the property.org.openapitools.jackson.nullable.JsonNullable
<List<GroupSchemaAttributeEnumInner>> 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.Namespace from the external applicationIdentifies the type of data represented by the stringIdentifies where the property is masteredorg.openapitools.jackson.nullable.JsonNullable
<UserSchemaAttributeMaster> Maximum character length of a string propertyorg.openapitools.jackson.nullable.JsonNullable
<Integer> Minimum character length of a string propertyorg.openapitools.jackson.nullable.JsonNullable
<Integer> Defines the mutability of the propertygetOneOf()
Non-empty array of valid JSON schemas.org.openapitools.jackson.nullable.JsonNullable
<List<UserSchemaAttributeEnum>> For `string` property types, specifies the regular expression used to validate the propertyAccess control permissions for the propertyorg.openapitools.jackson.nullable.JsonNullable
<List<UserSchemaAttributePermission>> Determines whether the property is requiredorg.openapitools.jackson.nullable.JsonNullable
<Boolean> getScope()
Get scopegetTitle()
User-defined display name for the propertygetType()
Type of propertyDetermines whether property values must be uniqueorg.openapitools.jackson.nullable.JsonNullable
<Boolean> int
hashCode()
master
(UserSchemaAttributeMaster master) mutability
(UserSchemaAttributeMutabilityString mutability) oneOf
(List<UserSchemaAttributeEnum> oneOf) permissions
(List<UserSchemaAttributePermission> permissions) scope
(UserSchemaAttributeScope scope) void
setDescription
(String description) void
setEnum
(List<GroupSchemaAttributeEnumInner> _enum) void
setEnum_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<List<GroupSchemaAttributeEnumInner>> _enum) void
setExternalName
(String externalName) void
setExternalNamespace
(String externalNamespace) void
setFormat
(UserSchemaAttributeFormat format) void
setMaster
(UserSchemaAttributeMaster master) void
setMaster_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<UserSchemaAttributeMaster> master) void
setMaxLength
(Integer maxLength) void
setMaxLength_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Integer> maxLength) void
setMinLength
(Integer minLength) void
setMinLength_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Integer> minLength) void
setMutability
(UserSchemaAttributeMutabilityString mutability) void
setOneOf
(List<UserSchemaAttributeEnum> oneOf) void
setOneOf_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributeEnum>> oneOf) void
setPattern
(String pattern) void
setPermissions
(List<UserSchemaAttributePermission> permissions) void
setPermissions_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributePermission>> permissions) void
setRequired
(Boolean required) void
setRequired_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Boolean> required) void
setScope
(UserSchemaAttributeScope scope) void
void
void
void
setUnique_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Boolean> unique) toString()
type
(UserSchemaAttributeType type)
-
Field Details
-
JSON_PROPERTY_DESCRIPTION
- See Also:
-
JSON_PROPERTY_ENUM
- See Also:
-
JSON_PROPERTY_EXTERNAL_NAME
- See Also:
-
JSON_PROPERTY_EXTERNAL_NAMESPACE
- See Also:
-
JSON_PROPERTY_FORMAT
- See Also:
-
JSON_PROPERTY_MASTER
- See Also:
-
JSON_PROPERTY_MAX_LENGTH
- See Also:
-
JSON_PROPERTY_MIN_LENGTH
- See Also:
-
JSON_PROPERTY_MUTABILITY
- See Also:
-
JSON_PROPERTY_ONE_OF
- See Also:
-
JSON_PROPERTY_PATTERN
- See Also:
-
JSON_PROPERTY_PERMISSIONS
- See Also:
-
JSON_PROPERTY_REQUIRED
- See Also:
-
JSON_PROPERTY_SCOPE
- See Also:
-
JSON_PROPERTY_TITLE
- See Also:
-
JSON_PROPERTY_TYPE
- See Also:
-
JSON_PROPERTY_UNIQUE
- See Also:
-
-
Constructor Details
-
UserSchemaAttribute
public UserSchemaAttribute()
-
-
Method Details
-
description
-
getDescription
Description of the property- Returns:
- description
-
setDescription
-
_enum
-
addenumItem
-
getEnum
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.- Returns:
- _enum
-
getEnum_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<GroupSchemaAttributeEnumInner>> getEnum_JsonNullable() -
setEnum_JsonNullable
public void setEnum_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<GroupSchemaAttributeEnumInner>> _enum) -
setEnum
-
externalName
-
getExternalName
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.- Returns:
- externalName
-
setExternalName
-
externalNamespace
-
getExternalNamespace
Namespace from the external application- Returns:
- externalNamespace
-
setExternalNamespace
-
format
-
getFormat
Identifies the type of data represented by the string- Returns:
- format
-
setFormat
-
master
-
getMaster
Identifies where the property is mastered- Returns:
- master
-
getMaster_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<UserSchemaAttributeMaster> getMaster_JsonNullable() -
setMaster_JsonNullable
public void setMaster_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<UserSchemaAttributeMaster> master) -
setMaster
-
maxLength
-
getMaxLength
Maximum character length of a string property- Returns:
- maxLength
-
getMaxLength_JsonNullable
-
setMaxLength_JsonNullable
public void setMaxLength_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> maxLength) -
setMaxLength
-
minLength
-
getMinLength
Minimum character length of a string property- Returns:
- minLength
-
getMinLength_JsonNullable
-
setMinLength_JsonNullable
public void setMinLength_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> minLength) -
setMinLength
-
mutability
-
getMutability
Defines the mutability of the property- Returns:
- mutability
-
setMutability
-
oneOf
-
addoneOfItem
-
getOneOf
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.- Returns:
- oneOf
-
getOneOf_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributeEnum>> getOneOf_JsonNullable() -
setOneOf_JsonNullable
public void setOneOf_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributeEnum>> oneOf) -
setOneOf
-
pattern
-
getPattern
For `string` property types, specifies the regular expression used to validate the property- Returns:
- pattern
-
setPattern
-
permissions
-
addpermissionsItem
-
getPermissions
Access control permissions for the property- Returns:
- permissions
-
getPermissions_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributePermission>> getPermissions_JsonNullable() -
setPermissions_JsonNullable
public void setPermissions_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributePermission>> permissions) -
setPermissions
-
required
-
getRequired
Determines whether the property is required- Returns:
- required
-
getRequired_JsonNullable
-
setRequired_JsonNullable
public void setRequired_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> required) -
setRequired
-
scope
-
getScope
Get scope- Returns:
- scope
-
setScope
-
title
-
getTitle
User-defined display name for the property- Returns:
- title
-
setTitle
-
type
-
getType
Type of property- Returns:
- type
-
setType
-
unique
-
getUnique
Determines whether property values must be unique- Returns:
- unique
-
getUnique_JsonNullable
-
setUnique_JsonNullable
-
setUnique
-
equals
-
hashCode
public int hashCode() -
toString
-