com.unboundid.scim.schema

Class CoreSchema

java.lang.Object

com.unboundid.scim.schema.CoreSchema

public class CoreSchema
extends Object

Contains the resources and their attributes defined in Core Schema 1.1.

Field Summary

Fields

Modifier and Type	Field and Description
static AttributeDescriptor	ACTIVE Active status attribute.
static AttributeDescriptor	ADDRESS_COUNTRY Address country attribute.
static AttributeDescriptor	ADDRESS_FORMATTED Formatted-address attribute.
static AttributeDescriptor	ADDRESS_LOCALITY Address locality attribute.
static AttributeDescriptor	ADDRESS_POSTAL_CODE Address postal code attribute.
static AttributeDescriptor	ADDRESS_REGION Address region attribute.
static AttributeDescriptor	ADDRESS_STREET_ADDRESS Street address attribute.
static AttributeDescriptor	ADDRESSES Addresses attribute.
static AttributeDescriptor	ATTRIBUTES_CANONICAL_VALUES Attribute canonical values.
static AttributeDescriptor	ATTRIBUTES_CASE_EXACT Attribute case-exact.
static AttributeDescriptor	ATTRIBUTES_DESCRIPTION Attribute description.
static AttributeDescriptor	ATTRIBUTES_MULTIVALUED Multivalued type.
static AttributeDescriptor	ATTRIBUTES_MULTIVALUED_CHILD_NAME Multivalued child name.
static AttributeDescriptor	ATTRIBUTES_NAME Attribute name.
static AttributeDescriptor	ATTRIBUTES_READ_ONLY Attribute read-only.
static AttributeDescriptor	ATTRIBUTES_REQUIRED Attribute required.
static AttributeDescriptor	ATTRIBUTES_SCHEMA Attribute schema.
static AttributeDescriptor	ATTRIBUTES_TYPE Attribute type.
static AttributeDescriptor	AUTH_SCHEME_DESCRIPTION Authentication scheme description attribute.
static AttributeDescriptor	AUTH_SCHEME_DOCUMENTATION_URL Authentication scheme documentation URL attribute.
static AttributeDescriptor	AUTH_SCHEME_NAME Authentication scheme name attribute.
static AttributeDescriptor	AUTH_SCHEME_SPEC_URL Authentication scheme specification URL attribute.
static AttributeDescriptor	AUTH_SCHEMES Authentication schemes attribute.
static AttributeDescriptor	BULK_CONFIG Bulk operations configuration attribute.
static AttributeDescriptor	BULK_MAX_OPERATIONS Bulk max operations attribute.
static AttributeDescriptor	BULK_MAX_PAYLOAD_SIZE Bulk max payload size attribute.
static AttributeDescriptor	BULK_SUPPORTED Bulk processing-supported attribute.
static AttributeDescriptor	CHANGE_PASSWORD_CONFIG Change password configuration attribute.
static AttributeDescriptor	CHANGE_PASSWORD_SUPPORTED Change password-supported attribute.
static AttributeDescriptor	CONFIG_DOCUMENTATION_URL Configuration documentation attribute.
static AttributeDescriptor	COST_CENTER Cost center attribute.
static AttributeDescriptor	DEPARTMENT Department attribute.
static AttributeDescriptor	DISPLAY_NAME Display name attribute.
static AttributeDescriptor	DIVISION Division attribute.
static AttributeDescriptor	EMAILS Emails attribute.
static AttributeDescriptor	EMPLOYEE_NUMBER Employee number attribute.
static AttributeDescriptor	ENTITLEMENTS Entitlements attribute.
static AttributeDescriptor	ETAG_CONFIG ETag configuration attribute.
static AttributeDescriptor	ETAG_SUPPORTED ETag-supported attribute.
static AttributeDescriptor	EXTERNAL_ID ExternalID attribute.
static AttributeDescriptor	EXTERNAL_ID_DESCRIPTOR The SCIM AttributeDescriptor for the externalId attribute.
static AttributeDescriptor	FILTER_CONFIG Filter configuration attribute.
static AttributeDescriptor	FILTER_MAX_RESULTS Filter max results attribute.
static AttributeDescriptor	FILTER_SUPPORTED Filter-supported attribute.
static ResourceDescriptor	GROUP_DESCRIPTOR The SCIM Group Schema.
static AttributeDescriptor	GROUP_DISPLAY_NAME Group display name attribute.
static AttributeDescriptor	GROUPS Groups attribute.
static AttributeDescriptor	ID ID attribute.
static AttributeDescriptor	ID_DESCRIPTOR The SCIM AttributeDescriptor for the id attribute.
static AttributeDescriptor	IMS IMs attribute.
static AttributeDescriptor	LOCALE Locale attribute.
static AttributeDescriptor	MANAGER Manager attribute.
static AttributeDescriptor	MANAGER_DISPLAY_NAME Manager display name attribute.
static AttributeDescriptor	MANAGER_ID Manager ID attribute.
static AttributeDescriptor	MEMBERS Members attribute.
static AttributeDescriptor	META Meta attribute.
static AttributeDescriptor	META_ATTRIBUTES Meta attributes removed during a PATCH operation.
static AttributeDescriptor	META_CREATED Created meta attribute.
static AttributeDescriptor	META_DESCRIPTOR The SCIM AttributeDescriptor for the meta attribute.
static AttributeDescriptor	META_LAST_MODIFIED Last modified meta attribute.
static AttributeDescriptor	META_LOCATION Location meta attribute.
static AttributeDescriptor	META_VERSION Version meta attribute.
static AttributeDescriptor	NAME Name attribute.
static AttributeDescriptor	NAME_FAMILY_NAME Family name attribute.
static AttributeDescriptor	NAME_FORMATTED Formatted name attribute.
static AttributeDescriptor	NAME_GIVEN_NAME Given name attribute.
static AttributeDescriptor	NAME_HONORIFIC_PREFIX Honorific name prefix attribute.
static AttributeDescriptor	NAME_HONORIFIC_SUFFIX Honorific name suffix attribute.
static AttributeDescriptor	NAME_MIDDLE_NAME Middle name attribute.
static com.unboundid.scim.schema.AttributeDescriptor.AttributeDescriptorResolver	NESTING_ATTRIBUTES_RESOLVER Nesting attributes resolver.
static AttributeDescriptor	NICK_NAME Nick name attribute.
static AttributeDescriptor	ORGANIZATION Organization attribute.
static AttributeDescriptor	PASSWORD Password attribute.
static AttributeDescriptor	PATCH_CONFIG PATCH configuration options attribute.
static AttributeDescriptor	PATCH_SUPPORTED PATCH operation-supported attribute.
static AttributeDescriptor	PHONE_NUMBERS Phone numbers attribute.
static AttributeDescriptor	PHOTOS Photos attribute.
static AttributeDescriptor	PREFERRED_LANGUAGE Preferred language attribute.
static AttributeDescriptor	PROFILE_URL Profile URL attribute.
static AttributeDescriptor	RESOURCE_ATTRIBUTES Resource attributes.
static AttributeDescriptor	RESOURCE_DESCRIPTION Resource description attribute.
static AttributeDescriptor	RESOURCE_ENDPOINT Resource endpoint.
static AttributeDescriptor	RESOURCE_NAME Resource name attribute.
static AttributeDescriptor	RESOURCE_SCHEMA Resource schema.
static ResourceDescriptor	RESOURCE_SCHEMA_DESCRIPTOR The SCIM Resource Schema.
static AttributeDescriptor	RESOURCE_SUB_ATTRIBUTES Resource sub-attributes.
static AttributeDescriptor	ROLES Roles attribute.
static ResourceDescriptor	SERVICE_PROVIDER_CONFIG_SCHEMA_DESCRIPTOR The SCIM Service Provider Configuration Schema.
static AttributeDescriptor	SORT_CONFIG Sorting configuration attribute.
static AttributeDescriptor	SORT_SUPPORTED Sorting-supported attribute.
static AttributeDescriptor	TIMEZONE Time zone attribute.
static AttributeDescriptor	TITLE Title attribute.
static ResourceDescriptor	USER_DESCRIPTOR The SCIM User Schema.
static AttributeDescriptor	USER_NAME Username attribute.
static AttributeDescriptor	USER_TYPE User type attribute.
static AttributeDescriptor	X509CERTIFICATES X.509 certificates attribute.
static AttributeDescriptor	XML_DATA_TYPE_CONFIG XML data type configuration attribute.
static AttributeDescriptor	XML_DATA_TYPE_SUPPORTED XML data type-supported attribute.

Constructor Summary

Constructors

Constructor and Description
CoreSchema()

Method Summary

Methods

Modifier and Type	Method and Description
static ResourceDescriptor	createCustomGroupResourceDescriptor(String groupResourceName, String groupsEndpointName) Creates a custom SCIM Group Schema resource descriptor.
static ResourceDescriptor	createCustomUserResourceDescriptor(String userResourceName, String usersEndpointName) Creates a custom SCIM User Schema resource descriptor.
static AttributeDescriptor	createMultiValuedDisplayDescriptor(String schema) Convenience method to create an attribute descriptor for the display normative sub-attribute of multi-valued attributes.
static AttributeDescriptor	createMultiValuedOperationDescriptor(String schema) Convenience method to create an attribute descriptor for the operation normative sub-attribute of multi-valued attributes.
static AttributeDescriptor	createMultiValuedPrimaryDescriptor(String schema) Convenience method to create an attribute descriptor for the primary normative sub-attribute of multi-valued attributes.
static AttributeDescriptor	createMultiValuedTypeDescriptor(String schema, String... canonicalValues) Convenience method to create an attribute descriptor for the type normative sub-attribute of multi-valued attributes.
static AttributeDescriptor	createMultiValuedValueDescriptor(String schema, AttributeDescriptor.DataType dataType) Convenience method to create an attribute descriptor for the value normative sub-attribute of multi-valued attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final AttributeDescriptor ID

ID attribute.

EXTERNAL_ID

public static final AttributeDescriptor EXTERNAL_ID

ExternalID attribute.

META_CREATED

public static final AttributeDescriptor META_CREATED

Created meta attribute.

META_LAST_MODIFIED

public static final AttributeDescriptor META_LAST_MODIFIED

Last modified meta attribute.

META_LOCATION

public static final AttributeDescriptor META_LOCATION

Location meta attribute.

META_VERSION

public static final AttributeDescriptor META_VERSION

Version meta attribute.

META_ATTRIBUTES

public static final AttributeDescriptor META_ATTRIBUTES

Meta attributes removed during a PATCH operation.

META

public static final AttributeDescriptor META

Meta attribute.

USER_NAME

public static final AttributeDescriptor USER_NAME

Username attribute.

NAME_FORMATTED

public static final AttributeDescriptor NAME_FORMATTED

Formatted name attribute.

NAME_FAMILY_NAME

public static final AttributeDescriptor NAME_FAMILY_NAME

Family name attribute.

NAME_GIVEN_NAME

public static final AttributeDescriptor NAME_GIVEN_NAME

Given name attribute.

NAME_MIDDLE_NAME

public static final AttributeDescriptor NAME_MIDDLE_NAME

Middle name attribute.

NAME_HONORIFIC_PREFIX

public static final AttributeDescriptor NAME_HONORIFIC_PREFIX

Honorific name prefix attribute.

NAME_HONORIFIC_SUFFIX

public static final AttributeDescriptor NAME_HONORIFIC_SUFFIX

Honorific name suffix attribute.

NAME

public static final AttributeDescriptor NAME

Name attribute.

DISPLAY_NAME

public static final AttributeDescriptor DISPLAY_NAME

Display name attribute.

NICK_NAME

public static final AttributeDescriptor NICK_NAME

Nick name attribute.

PROFILE_URL

public static final AttributeDescriptor PROFILE_URL

Profile URL attribute.

TITLE

public static final AttributeDescriptor TITLE

Title attribute.

USER_TYPE

public static final AttributeDescriptor USER_TYPE

User type attribute.

PREFERRED_LANGUAGE

public static final AttributeDescriptor PREFERRED_LANGUAGE

Preferred language attribute.

LOCALE

public static final AttributeDescriptor LOCALE

Locale attribute.

TIMEZONE

public static final AttributeDescriptor TIMEZONE

Time zone attribute.

ACTIVE

public static final AttributeDescriptor ACTIVE

Active status attribute.

PASSWORD

public static final AttributeDescriptor PASSWORD

Password attribute.

EMAILS

public static final AttributeDescriptor EMAILS

Emails attribute.

PHONE_NUMBERS

public static final AttributeDescriptor PHONE_NUMBERS

Phone numbers attribute.

IMS

public static final AttributeDescriptor IMS

IMs attribute.

PHOTOS

public static final AttributeDescriptor PHOTOS

Photos attribute.

ADDRESS_FORMATTED

public static final AttributeDescriptor ADDRESS_FORMATTED

Formatted-address attribute.

ADDRESS_STREET_ADDRESS

public static final AttributeDescriptor ADDRESS_STREET_ADDRESS

Street address attribute.

ADDRESS_LOCALITY

public static final AttributeDescriptor ADDRESS_LOCALITY

Address locality attribute.

ADDRESS_REGION

public static final AttributeDescriptor ADDRESS_REGION

Address region attribute.

ADDRESS_POSTAL_CODE

public static final AttributeDescriptor ADDRESS_POSTAL_CODE

Address postal code attribute.

ADDRESS_COUNTRY

public static final AttributeDescriptor ADDRESS_COUNTRY

Address country attribute.

ADDRESSES

public static final AttributeDescriptor ADDRESSES

Addresses attribute.

GROUPS

public static final AttributeDescriptor GROUPS

Groups attribute.

ENTITLEMENTS

public static final AttributeDescriptor ENTITLEMENTS

Entitlements attribute.

ROLES

public static final AttributeDescriptor ROLES

Roles attribute.

X509CERTIFICATES

public static final AttributeDescriptor X509CERTIFICATES

X.509 certificates attribute.

EMPLOYEE_NUMBER

public static final AttributeDescriptor EMPLOYEE_NUMBER

Employee number attribute.

COST_CENTER

public static final AttributeDescriptor COST_CENTER

Cost center attribute.

ORGANIZATION

public static final AttributeDescriptor ORGANIZATION

Organization attribute.

DIVISION

public static final AttributeDescriptor DIVISION

Division attribute.

DEPARTMENT

public static final AttributeDescriptor DEPARTMENT

Department attribute.

MANAGER_ID

public static final AttributeDescriptor MANAGER_ID

Manager ID attribute.

MANAGER_DISPLAY_NAME

public static final AttributeDescriptor MANAGER_DISPLAY_NAME

Manager display name attribute.

MANAGER

public static final AttributeDescriptor MANAGER

Manager attribute.

GROUP_DISPLAY_NAME

public static final AttributeDescriptor GROUP_DISPLAY_NAME

Group display name attribute.

MEMBERS

public static final AttributeDescriptor MEMBERS

Members attribute.

CONFIG_DOCUMENTATION_URL

public static final AttributeDescriptor CONFIG_DOCUMENTATION_URL

Configuration documentation attribute.

PATCH_SUPPORTED

public static final AttributeDescriptor PATCH_SUPPORTED

PATCH operation-supported attribute.

BULK_SUPPORTED

public static final AttributeDescriptor BULK_SUPPORTED

Bulk processing-supported attribute.

BULK_MAX_OPERATIONS

public static final AttributeDescriptor BULK_MAX_OPERATIONS

Bulk max operations attribute.

BULK_MAX_PAYLOAD_SIZE

public static final AttributeDescriptor BULK_MAX_PAYLOAD_SIZE

Bulk max payload size attribute.

FILTER_SUPPORTED

public static final AttributeDescriptor FILTER_SUPPORTED

Filter-supported attribute.

FILTER_MAX_RESULTS

public static final AttributeDescriptor FILTER_MAX_RESULTS

Filter max results attribute.

CHANGE_PASSWORD_SUPPORTED

public static final AttributeDescriptor CHANGE_PASSWORD_SUPPORTED

Change password-supported attribute.

SORT_SUPPORTED

public static final AttributeDescriptor SORT_SUPPORTED

Sorting-supported attribute.

ETAG_SUPPORTED

public static final AttributeDescriptor ETAG_SUPPORTED

ETag-supported attribute.

AUTH_SCHEME_NAME

public static final AttributeDescriptor AUTH_SCHEME_NAME

Authentication scheme name attribute.

AUTH_SCHEME_DESCRIPTION

public static final AttributeDescriptor AUTH_SCHEME_DESCRIPTION

Authentication scheme description attribute.

AUTH_SCHEME_SPEC_URL

public static final AttributeDescriptor AUTH_SCHEME_SPEC_URL

Authentication scheme specification URL attribute.

AUTH_SCHEME_DOCUMENTATION_URL

public static final AttributeDescriptor AUTH_SCHEME_DOCUMENTATION_URL

Authentication scheme documentation URL attribute.

XML_DATA_TYPE_SUPPORTED

public static final AttributeDescriptor XML_DATA_TYPE_SUPPORTED

XML data type-supported attribute.

PATCH_CONFIG

public static final AttributeDescriptor PATCH_CONFIG

PATCH configuration options attribute.

BULK_CONFIG

public static final AttributeDescriptor BULK_CONFIG

Bulk operations configuration attribute.

FILTER_CONFIG

public static final AttributeDescriptor FILTER_CONFIG

Filter configuration attribute.

CHANGE_PASSWORD_CONFIG

public static final AttributeDescriptor CHANGE_PASSWORD_CONFIG

Change password configuration attribute.

SORT_CONFIG

public static final AttributeDescriptor SORT_CONFIG

Sorting configuration attribute.

ETAG_CONFIG

public static final AttributeDescriptor ETAG_CONFIG

ETag configuration attribute.

AUTH_SCHEMES

public static final AttributeDescriptor AUTH_SCHEMES

Authentication schemes attribute.

XML_DATA_TYPE_CONFIG

public static final AttributeDescriptor XML_DATA_TYPE_CONFIG

XML data type configuration attribute.

RESOURCE_NAME

public static final AttributeDescriptor RESOURCE_NAME

Resource name attribute.

RESOURCE_DESCRIPTION

public static final AttributeDescriptor RESOURCE_DESCRIPTION

Resource description attribute.

RESOURCE_SCHEMA

public static final AttributeDescriptor RESOURCE_SCHEMA

Resource schema.

RESOURCE_ENDPOINT

public static final AttributeDescriptor RESOURCE_ENDPOINT

Resource endpoint.

ATTRIBUTES_NAME

public static final AttributeDescriptor ATTRIBUTES_NAME

Attribute name.

ATTRIBUTES_TYPE

public static final AttributeDescriptor ATTRIBUTES_TYPE

Attribute type.

ATTRIBUTES_MULTIVALUED

public static final AttributeDescriptor ATTRIBUTES_MULTIVALUED

Multivalued type.

ATTRIBUTES_MULTIVALUED_CHILD_NAME

public static final AttributeDescriptor ATTRIBUTES_MULTIVALUED_CHILD_NAME

Multivalued child name.

ATTRIBUTES_DESCRIPTION

public static final AttributeDescriptor ATTRIBUTES_DESCRIPTION

Attribute description.

ATTRIBUTES_SCHEMA

public static final AttributeDescriptor ATTRIBUTES_SCHEMA

Attribute schema.

ATTRIBUTES_READ_ONLY

public static final AttributeDescriptor ATTRIBUTES_READ_ONLY

Attribute read-only.

ATTRIBUTES_REQUIRED

public static final AttributeDescriptor ATTRIBUTES_REQUIRED

Attribute required.

ATTRIBUTES_CASE_EXACT

public static final AttributeDescriptor ATTRIBUTES_CASE_EXACT

Attribute case-exact.

ATTRIBUTES_CANONICAL_VALUES

public static final AttributeDescriptor ATTRIBUTES_CANONICAL_VALUES

Attribute canonical values.

RESOURCE_SUB_ATTRIBUTES

public static final AttributeDescriptor RESOURCE_SUB_ATTRIBUTES

Resource sub-attributes.

RESOURCE_ATTRIBUTES

public static final AttributeDescriptor RESOURCE_ATTRIBUTES

Resource attributes.

NESTING_ATTRIBUTES_RESOLVER

public static final com.unboundid.scim.schema.AttributeDescriptor.AttributeDescriptorResolver NESTING_ATTRIBUTES_RESOLVER

Nesting attributes resolver.

RESOURCE_SCHEMA_DESCRIPTOR

public static final ResourceDescriptor RESOURCE_SCHEMA_DESCRIPTOR

The SCIM Resource Schema.

SERVICE_PROVIDER_CONFIG_SCHEMA_DESCRIPTOR

public static final ResourceDescriptor SERVICE_PROVIDER_CONFIG_SCHEMA_DESCRIPTOR

The SCIM Service Provider Configuration Schema.

USER_DESCRIPTOR

public static final ResourceDescriptor USER_DESCRIPTOR

The SCIM User Schema.

GROUP_DESCRIPTOR

public static final ResourceDescriptor GROUP_DESCRIPTOR

The SCIM Group Schema.

META_DESCRIPTOR

public static final AttributeDescriptor META_DESCRIPTOR

The SCIM AttributeDescriptor for the meta attribute.

ID_DESCRIPTOR

public static final AttributeDescriptor ID_DESCRIPTOR

The SCIM AttributeDescriptor for the id attribute.

EXTERNAL_ID_DESCRIPTOR

public static final AttributeDescriptor EXTERNAL_ID_DESCRIPTOR

The SCIM AttributeDescriptor for the externalId attribute.

Constructor Detail

CoreSchema

public CoreSchema()

Method Detail

createCustomUserResourceDescriptor

public static ResourceDescriptor createCustomUserResourceDescriptor(String userResourceName,
                                                    String usersEndpointName)

Creates a custom SCIM User Schema resource descriptor.

Parameters:

userResourceName - Provide a custom user resource name.

usersEndpointName - Provide a custom users endpoint name.

Returns:

User ResourceDescriptor

createCustomGroupResourceDescriptor

public static ResourceDescriptor createCustomGroupResourceDescriptor(String groupResourceName,
                                                     String groupsEndpointName)

Creates a custom SCIM Group Schema resource descriptor.

Parameters:

groupResourceName - Provide a custom group resource name.

groupsEndpointName - Provide a custom groups endpoint name.

Returns:

Group ResourceDescriptor

createMultiValuedTypeDescriptor

public static AttributeDescriptor createMultiValuedTypeDescriptor(String schema,
                                                  String... canonicalValues)

Convenience method to create an attribute descriptor for the type normative sub-attribute of multi-valued attributes.

Parameters:

schema - The attribute's associated schema.

canonicalValues - The canonical values to include in the descriptor.

Returns:

The attribute descriptor for the type normative sub-attribute of multi-valued attributes.

createMultiValuedPrimaryDescriptor

public static AttributeDescriptor createMultiValuedPrimaryDescriptor(String schema)

Convenience method to create an attribute descriptor for the primary normative sub-attribute of multi-valued attributes.

Parameters:

schema - The attribute's associated schema.

Returns:

The attribute descriptor for the primary normative sub-attribute of multi-valued attributes.

createMultiValuedDisplayDescriptor

public static AttributeDescriptor createMultiValuedDisplayDescriptor(String schema)

Convenience method to create an attribute descriptor for the display normative sub-attribute of multi-valued attributes.

Parameters:

schema - The attribute's associated schema.

Returns:

The attribute descriptor for the display normative sub-attribute of multi-valued attributes.

createMultiValuedOperationDescriptor

public static AttributeDescriptor createMultiValuedOperationDescriptor(String schema)

Convenience method to create an attribute descriptor for the operation normative sub-attribute of multi-valued attributes.

Parameters:

schema - The attribute's associated schema.

Returns:

The attribute descriptor for the display operation sub-attribute of multi-valued attributes.

createMultiValuedValueDescriptor

public static AttributeDescriptor createMultiValuedValueDescriptor(String schema,
                                                   AttributeDescriptor.DataType dataType)

Convenience method to create an attribute descriptor for the value normative sub-attribute of multi-valued attributes.

Parameters:

schema - The attribute's associated schema.

dataType - The data type of the value sub-attribute.

Returns:

The attribute descriptor for the value normative sub-attribute of multi-valued attributes.