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-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class UserSchemaAttribute
extends Object
implements Serializable

UserSchemaAttribute

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DESCRIPTION
static final String	JSON_PROPERTY_ENUM
static final String	JSON_PROPERTY_EXTERNAL_NAME
static final String	JSON_PROPERTY_EXTERNAL_NAMESPACE
static final String	JSON_PROPERTY_FORMAT
static final String	JSON_PROPERTY_MASTER
static final String	JSON_PROPERTY_MAX_LENGTH
static final String	JSON_PROPERTY_MIN_LENGTH
static final String	JSON_PROPERTY_MUTABILITY
static final String	JSON_PROPERTY_ONE_OF
static final String	JSON_PROPERTY_PATTERN
static final String	JSON_PROPERTY_PERMISSIONS
static final String	JSON_PROPERTY_REQUIRED
static final String	JSON_PROPERTY_SCOPE
static final String	JSON_PROPERTY_TITLE
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_UNIQUE

Constructor Summary

Constructors

Constructor	Description
UserSchemaAttribute()

Method Summary

Modifier and Type	Method	Description
UserSchemaAttribute	_enum(List<GroupSchemaAttributeEnumInner> _enum)
UserSchemaAttribute	addenumItem(GroupSchemaAttributeEnumInner _enumItem)
UserSchemaAttribute	addoneOfItem(UserSchemaAttributeEnum oneOfItem)
UserSchemaAttribute	addpermissionsItem(UserSchemaAttributePermission permissionsItem)
UserSchemaAttribute	description(String description)
boolean	equals(Object o)
UserSchemaAttribute	externalName(String externalName)
UserSchemaAttribute	externalNamespace(String externalNamespace)
UserSchemaAttribute	format(UserSchemaAttributeFormat format)
String	getDescription()	Description of the property
List<GroupSchemaAttributeEnumInner>	getEnum()	Enumerated value of the property.
org.openapitools.jackson.nullable.JsonNullable<List<GroupSchemaAttributeEnumInner>>	getEnum_JsonNullable()
String	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.
String	getExternalNamespace()	Namespace from the external application
UserSchemaAttributeFormat	getFormat()	Identifies the type of data represented by the string
UserSchemaAttributeMaster	getMaster()	Identifies where the property is mastered
org.openapitools.jackson.nullable.JsonNullable<UserSchemaAttributeMaster>	getMaster_JsonNullable()
Integer	getMaxLength()	Maximum character length of a string property
org.openapitools.jackson.nullable.JsonNullable<Integer>	getMaxLength_JsonNullable()
Integer	getMinLength()	Minimum character length of a string property
org.openapitools.jackson.nullable.JsonNullable<Integer>	getMinLength_JsonNullable()
UserSchemaAttributeMutabilityString	getMutability()	Defines the mutability of the property
List<UserSchemaAttributeEnum>	getOneOf()	Non-empty array of valid JSON schemas.
org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributeEnum>>	getOneOf_JsonNullable()
String	getPattern()	For `string` property types, specifies the regular expression used to validate the property
List<UserSchemaAttributePermission>	getPermissions()	Access control permissions for the property
org.openapitools.jackson.nullable.JsonNullable<List<UserSchemaAttributePermission>>	getPermissions_JsonNullable()
Boolean	getRequired()	Determines whether the property is required
org.openapitools.jackson.nullable.JsonNullable<Boolean>	getRequired_JsonNullable()
UserSchemaAttributeScope	getScope()	Get scope
String	getTitle()	User-defined display name for the property
UserSchemaAttributeType	getType()	Type of property
Boolean	getUnique()	Determines whether property values must be unique
org.openapitools.jackson.nullable.JsonNullable<Boolean>	getUnique_JsonNullable()
int	hashCode()
UserSchemaAttribute	master(UserSchemaAttributeMaster master)
UserSchemaAttribute	maxLength(Integer maxLength)
UserSchemaAttribute	minLength(Integer minLength)
UserSchemaAttribute	mutability(UserSchemaAttributeMutabilityString mutability)
UserSchemaAttribute	oneOf(List<UserSchemaAttributeEnum> oneOf)
UserSchemaAttribute	pattern(String pattern)
UserSchemaAttribute	permissions(List<UserSchemaAttributePermission> permissions)
UserSchemaAttribute	required(Boolean required)
UserSchemaAttribute	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	setTitle(String title)
void	setType(UserSchemaAttributeType type)
void	setUnique(Boolean unique)
void	setUnique_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> unique)
UserSchemaAttribute	title(String title)
String	toString()
UserSchemaAttribute	type(UserSchemaAttributeType type)
UserSchemaAttribute	unique(Boolean unique)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_DESCRIPTION

public static final String JSON_PROPERTY_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_ENUM

public static final String JSON_PROPERTY_ENUM

See Also:

• Constant Field Values

JSON_PROPERTY_EXTERNAL_NAME

public static final String JSON_PROPERTY_EXTERNAL_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_EXTERNAL_NAMESPACE

public static final String JSON_PROPERTY_EXTERNAL_NAMESPACE

See Also:

• Constant Field Values

JSON_PROPERTY_FORMAT

public static final String JSON_PROPERTY_FORMAT

See Also:

• Constant Field Values

JSON_PROPERTY_MASTER

public static final String JSON_PROPERTY_MASTER

See Also:

• Constant Field Values

JSON_PROPERTY_MAX_LENGTH

public static final String JSON_PROPERTY_MAX_LENGTH

See Also:

• Constant Field Values

JSON_PROPERTY_MIN_LENGTH

public static final String JSON_PROPERTY_MIN_LENGTH

See Also:

• Constant Field Values

JSON_PROPERTY_MUTABILITY

public static final String JSON_PROPERTY_MUTABILITY

See Also:

• Constant Field Values

JSON_PROPERTY_ONE_OF

public static final String JSON_PROPERTY_ONE_OF

See Also:

• Constant Field Values

JSON_PROPERTY_PATTERN

public static final String JSON_PROPERTY_PATTERN

See Also:

• Constant Field Values

JSON_PROPERTY_PERMISSIONS

public static final String JSON_PROPERTY_PERMISSIONS

See Also:

• Constant Field Values

JSON_PROPERTY_REQUIRED

public static final String JSON_PROPERTY_REQUIRED

See Also:

• Constant Field Values

JSON_PROPERTY_SCOPE

public static final String JSON_PROPERTY_SCOPE

See Also:

• Constant Field Values

JSON_PROPERTY_TITLE

public static final String JSON_PROPERTY_TITLE

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_UNIQUE

public static final String JSON_PROPERTY_UNIQUE

See Also:

• Constant Field Values

Constructor Details

UserSchemaAttribute

public UserSchemaAttribute()

Method Details

description

public UserSchemaAttribute description(String description)

getDescription

@Nullable
public String getDescription()

Description of the property

Returns:

description

setDescription

public void setDescription(String description)

_enum

public UserSchemaAttribute _enum(List<GroupSchemaAttributeEnumInner> _enum)

addenumItem

public UserSchemaAttribute addenumItem(GroupSchemaAttributeEnumInner _enumItem)

getEnum

@Nullable
public List<GroupSchemaAttributeEnumInner> 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

public void setEnum(List<GroupSchemaAttributeEnumInner> _enum)

externalName

public UserSchemaAttribute externalName(String externalName)

getExternalName

@Nullable
public String 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

public void setExternalName(String externalName)

externalNamespace

public UserSchemaAttribute externalNamespace(String externalNamespace)

getExternalNamespace

@Nullable
public String getExternalNamespace()

Namespace from the external application

Returns:

externalNamespace

setExternalNamespace

public void setExternalNamespace(String externalNamespace)

format

public UserSchemaAttribute format(UserSchemaAttributeFormat format)

getFormat

@Nullable
public UserSchemaAttributeFormat getFormat()

Identifies the type of data represented by the string

Returns:

format

setFormat

public void setFormat(UserSchemaAttributeFormat format)

master

public UserSchemaAttribute master(UserSchemaAttributeMaster master)

getMaster

@Nullable
public UserSchemaAttributeMaster 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

public void setMaster(UserSchemaAttributeMaster master)

maxLength

public UserSchemaAttribute maxLength(Integer maxLength)

getMaxLength

@Nullable
public Integer getMaxLength()

Maximum character length of a string property

Returns:

maxLength

getMaxLength_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Integer> getMaxLength_JsonNullable()

setMaxLength_JsonNullable

public void setMaxLength_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> maxLength)

setMaxLength

public void setMaxLength(Integer maxLength)

minLength

public UserSchemaAttribute minLength(Integer minLength)

getMinLength

@Nullable
public Integer getMinLength()

Minimum character length of a string property

Returns:

minLength

getMinLength_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Integer> getMinLength_JsonNullable()

setMinLength_JsonNullable

public void setMinLength_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Integer> minLength)

setMinLength

public void setMinLength(Integer minLength)

mutability

public UserSchemaAttribute mutability(UserSchemaAttributeMutabilityString mutability)

getMutability

@Nullable
public UserSchemaAttributeMutabilityString getMutability()

Defines the mutability of the property

Returns:

mutability

setMutability

public void setMutability(UserSchemaAttributeMutabilityString mutability)

oneOf

public UserSchemaAttribute oneOf(List<UserSchemaAttributeEnum> oneOf)

addoneOfItem

public UserSchemaAttribute addoneOfItem(UserSchemaAttributeEnum oneOfItem)

getOneOf

@Nullable
public List<UserSchemaAttributeEnum> 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

public void setOneOf(List<UserSchemaAttributeEnum> oneOf)

pattern

public UserSchemaAttribute pattern(String pattern)

getPattern

@Nullable
public String getPattern()

For `string` property types, specifies the regular expression used to validate the property

Returns:

pattern

setPattern

public void setPattern(String pattern)

permissions

public UserSchemaAttribute permissions(List<UserSchemaAttributePermission> permissions)

addpermissionsItem

public UserSchemaAttribute addpermissionsItem(UserSchemaAttributePermission permissionsItem)

getPermissions

@Nullable
public List<UserSchemaAttributePermission> 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

public void setPermissions(List<UserSchemaAttributePermission> permissions)

required

public UserSchemaAttribute required(Boolean required)

getRequired

@Nullable
public Boolean getRequired()

Determines whether the property is required

Returns:

required

getRequired_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Boolean> getRequired_JsonNullable()

setRequired_JsonNullable

public void setRequired_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> required)

setRequired

public void setRequired(Boolean required)

scope

public UserSchemaAttribute scope(UserSchemaAttributeScope scope)

getScope

@Nullable
public UserSchemaAttributeScope getScope()

Get scope

Returns:

scope

setScope

public void setScope(UserSchemaAttributeScope scope)

title

public UserSchemaAttribute title(String title)

getTitle

@Nullable
public String getTitle()

User-defined display name for the property

Returns:

title

setTitle

public void setTitle(String title)

type

public UserSchemaAttribute type(UserSchemaAttributeType type)

getType

@Nullable
public UserSchemaAttributeType getType()

Type of property

Returns:

type

setType

public void setType(UserSchemaAttributeType type)

unique

public UserSchemaAttribute unique(Boolean unique)

getUnique

@Nullable
public Boolean getUnique()

Determines whether property values must be unique

Returns:

unique

getUnique_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Boolean> getUnique_JsonNullable()

setUnique_JsonNullable

public void setUnique_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> unique)

setUnique

public void setUnique(Boolean unique)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object