draft-ietf-scim-core-schema-02.txt   draft-ietf-scim-core-schema-03.txt 
Network Working Group C. Mortimore, Ed. Network Working Group K. Grizzle
Internet-Draft Salesforce Internet-Draft SailPoint
Intended status: Standards Track P. Harding Intended status: Standards Track P. Hunt, Ed.
Expires: March 03, 2014 P. Madsen Expires: August 16, 2014 Oracle
Ping E. Wahlstroem
T. Drake Technology Nexus
UnboundID C. Mortimore
August 30, 2013 Salesforce
February 12, 2014
System for Cross-Domain Identity Management: Core Schema System for Cross-Domain Identity Management: Core Schema
draft-ietf-scim-core-schema-02 draft-ietf-scim-core-schema-03
Abstract Abstract
The System for Cross-Domain Identity Management (SCIM) specification The System for Cross-Domain Identity Management (SCIM) specification
is designed to make managing user identity in cloud based is designed to make managing user identity in cloud based
applications and services easier. The specification suite builds applications and services easier. The specification suite builds
upon experience with existing schemas and deployments, placing upon experience with existing schemas and deployments, placing
specific emphasis on simplicity of development and integration, while specific emphasis on simplicity of development and integration, while
applying existing authentication, authorization, and privacy models. applying existing authentication, authorization, and privacy models.
Its intent is to reduce the cost and complexity of user management Its intent is to reduce the cost and complexity of user management
skipping to change at page 2, line 4 skipping to change at page 2, line 4
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on March 03, 2014. This Internet-Draft will expire on August 16, 2014.
Copyright Notice Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the Copyright (c) 2014 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Requirements Notation and Conventions . . . . . . . . . . . . 3 1. Requirements Notation and Conventions . . . . . . . . . . . . 3
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4 2.1. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
3. SCIM Schema Structure . . . . . . . . . . . . . . . . . . . . 4 3. SCIM Schema Structure . . . . . . . . . . . . . . . . . . . . 4
3.1. Attribute Data Types . . . . . . . . . . . . . . . . . . 5 3.1. Attribute Data Types . . . . . . . . . . . . . . . . . . 5
3.1.1. String . . . . . . . . . . . . . . . . . . . . . . . 5 3.1.1. String . . . . . . . . . . . . . . . . . . . . . . . 5
3.1.2. Boolean . . . . . . . . . . . . . . . . . . . . . . . 5 3.1.2. Boolean . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.3. Decimal . . . . . . . . . . . . . . . . . . . . . . . 5 3.1.3. Decimal . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.4. Integer . . . . . . . . . . . . . . . . . . . . . . . 5 3.1.4. Integer . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.5. DateTime . . . . . . . . . . . . . . . . . . . . . . 6 3.1.5. DateTime . . . . . . . . . . . . . . . . . . . . . . 6
3.1.6. Binary . . . . . . . . . . . . . . . . . . . . . . . 6 3.1.6. Binary . . . . . . . . . . . . . . . . . . . . . . . 6
3.1.7. Reference . . . . . . . . . . . . . . . . . . . . . . 6 3.1.7. Reference . . . . . . . . . . . . . . . . . . . . . . 6
3.1.8. Complex . . . . . . . . . . . . . . . . . . . . . . . 6 3.1.8. Complex . . . . . . . . . . . . . . . . . . . . . . . 7
3.2. Multi-valued Attributes . . . . . . . . . . . . . . . . . 6 3.2. Multi-valued Attributes . . . . . . . . . . . . . . . . . 7
4. Schema Extension Model . . . . . . . . . . . . . . . . . . . 8 4. Schema Extension Model . . . . . . . . . . . . . . . . . . . 8
5. SCIM Core Schema . . . . . . . . . . . . . . . . . . . . . . 8 5. SCIM Core Schema . . . . . . . . . . . . . . . . . . . . . . 8
5.1. Common Schema Attributes . . . . . . . . . . . . . . . . 8 5.1. Common Schema Attributes . . . . . . . . . . . . . . . . 8
5.2. "schemas" Attribute . . . . . . . . . . . . . . . . . . . 9 5.2. "schemas" Attribute . . . . . . . . . . . . . . . . . . . 10
6. SCIM User Schema . . . . . . . . . . . . . . . . . . . . . . 10 6. SCIM User Schema . . . . . . . . . . . . . . . . . . . . . . 10
6.1. Singular Attributes . . . . . . . . . . . . . . . . . . . 10 6.1. Singular Attributes . . . . . . . . . . . . . . . . . . . 10
6.2. Multi-valued Attributes . . . . . . . . . . . . . . . . . 12 6.2. Multi-valued Attributes . . . . . . . . . . . . . . . . . 12
7. SCIM Enterprise User Schema Extension . . . . . . . . . . . . 14 7. SCIM Enterprise User Schema Extension . . . . . . . . . . . . 14
8. SCIM Group Schema . . . . . . . . . . . . . . . . . . . . . . 15 8. SCIM Group Schema . . . . . . . . . . . . . . . . . . . . . . 15
9. Service Provider Configuration Schema . . . . . . . . . . . . 15 9. Service Provider Configuration Schema . . . . . . . . . . . . 16
10. Resource Type Schema . . . . . . . . . . . . . . . . . . . . 17 10. ResourceType Schema . . . . . . . . . . . . . . . . . . . . . 17
11. Schema Schema . . . . . . . . . . . . . . . . . . . . . . . . 18 11. Schema Schema . . . . . . . . . . . . . . . . . . . . . . . . 18
12. JSON Representation . . . . . . . . . . . . . . . . . . . . . 20 12. JSON Representation . . . . . . . . . . . . . . . . . . . . . 23
12.1. Minimal User Representation . . . . . . . . . . . . . . 20 12.1. Minimal User Representation . . . . . . . . . . . . . . 23
12.2. Full User Representation . . . . . . . . . . . . . . . . 20 12.2. Full User Representation . . . . . . . . . . . . . . . . 23
12.3. Enterprise User Extension Representation . . . . . . . . 23 12.3. Enterprise User Extension Representation . . . . . . . . 26
12.4. Group Representation . . . . . . . . . . . . . . . . . . 26 12.4. Group Representation . . . . . . . . . . . . . . . . . . 29
12.5. Service Provider Configuration Representation . . . . . 27 12.5. Service Provider Configuration Representation . . . . . 30
12.6. Resource Type Representation . . . . . . . . . . . . . . 28 12.6. Resource Type Representation . . . . . . . . . . . . . . 31
12.7. Schema Representation . . . . . . . . . . . . . . . . . 29 12.7. Schema Representation . . . . . . . . . . . . . . . . . 31
13. Security Considerations . . . . . . . . . . . . . . . . . . . 33 13. Security Considerations . . . . . . . . . . . . . . . . . . . 53
14. Normative References . . . . . . . . . . . . . . . . . . . . 33 14. References . . . . . . . . . . . . . . . . . . . . . . . . . 53
Appendix A. Contributors . . . . . . . . . . . . . . . . . . . . 34 14.1. Normative References . . . . . . . . . . . . . . . . . . 53
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 34 14.2. Informative References . . . . . . . . . . . . . . . . . 54
Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 54
Appendix B. Change Log . . . . . . . . . . . . . . . . . . . . . 55
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 55
1. Requirements Notation and Conventions 1. Requirements Notation and Conventions
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119] . document are to be interpreted as described in [RFC2119] .
Throughout this document, values are quoted to indicate that they are Throughout this document, values are quoted to indicate that they are
to be taken literally. When using these values in protocol messages, to be taken literally. When using these values in protocol messages,
the quotes MUST NOT be used as part of the value. the quotes MUST NOT be used as part of the value.
skipping to change at page 4, line 7 skipping to change at page 4, line 10
services. services.
This document provides a platform neutral schema and extension model This document provides a platform neutral schema and extension model
for representing users and groups in JSON format. This schema is for representing users and groups in JSON format. This schema is
intended for exchange and use with cloud service providers. intended for exchange and use with cloud service providers.
Additional binding documents provide a standard REST API, SAML Additional binding documents provide a standard REST API, SAML
binding, and use cases. binding, and use cases.
2.1. Definitions 2.1. Definitions
Service Provider: A web application that provides identity Service Provider: An HTTP web application that provides identity
information via the SCIM protocol. information via the SCIM protocol.
Consumer: A website or application that uses the SCIM protocol to Client: A website or application that uses the SCIM protocol to
manage identity data maintained by the Service Provider. manage identity data maintained by the service provider. The
client initiates SCIM HTTP requests to a target service provider.
Resource: The Service Provider managed artifact containing one or Resource: The service provider managed artifact containing one or
more attributes; e.g., User or Group more attributes; e.g., "User" or "Group".
Resource Type: A type of a Resource that is managed by a Service Resource Type: A type of a resource that is managed by a service
Provider. The Resource Type defines the Resource name, endpoint provider. The resource type defines the resource name, endpoint
URL, Schemas, and other meta-data which indicate where a Resource URL, Schemas, and other meta-data which indicate where a resource
is managed and how it is composed; e.g., User or Group. is managed and how it is composed; e.g., "User" or "Group".
Schema: A collection of Attribute Definitions that describe the Schema: A collection of Attribute Definitions that describe the
contents of an entire or partial Resource; e.g., contents of an entire or partial resource; e.g.,
urn:scim:schemas:core:User:2.0. "urn:scim:schemas:core:2.0:User".
Singular Attribute: A Resource attribute that contains 0..1 values; Singular Attribute: A resource attribute that contains 0..1 values;
e.g., displayName. e.g., "displayName".
Multi-valued Attribute: A Resource attribute that contains 0..n Multi-valued Attribute: A resource attribute that contains 0..n
values; e.g., emails. values; e.g., "emails".
Simple Attribute: A Singular or Multi-valued Attribute whose value Simple Attribute: A singular or multi-valued attribute whose value
is a primitive; e.g., String. is a primitive; e.g., "String".
Complex Attribute: A Singular or Multi-valued Attribute whose value Complex Attribute: A singular or multi-valued attribute whose value
is a composition of one or more Simple Attributes. is a composition of one or more simple attributes; e.g.,
"addresses".
Sub-Attribute: A Simple Attribute contained within a Complex Sub-Attribute: A simple attribute contained within a complex
Attribute. attribute.
3. SCIM Schema Structure 3. SCIM Schema Structure
SCIM schema provides a minimal core schema for representing users and SCIM schema provides a minimal core schema for representing users and
groups (resources), encompassing common attributes found in many groups (resources), encompassing common attributes found in many
existing deployments and schemas. existing deployments and schemas.
A resource is a collection of attributes identified by one or more A resource is a collection of attributes identified by one or more
schemas. Minimally, an attribute consists of the attribute name and schemas. Minimally, an attribute consists of the attribute name and
at least one Simple or Complex value either of which may be Multi- at least one simple or complex value either of which may be multi-
valued. SCIM schema defines the data type, plurality and other valued. SCIM schema defines the data type, plurality and other
distinguishing features of an attribute. Unless otherwise specified distinguishing features of an attribute. Unless otherwise specified
all attributes are modifiable by Consumers. Immutable (read-only) all attributes are modifiable by consumers. Attribute definitions
attributes SHALL be specified as 'READ-ONLY' within the attribute contain a property "mutability" that determines whether an attribute
definition. Additionally, Service Providers MAY choose to make some is: "readOnly", "writeOnly", "immutable", or "readWrite"(the
or all Resource attributes immutable and SHOULD identify those default). Additionally, service providers MAY define other
attributes via the associated Resource's schema endpoint properties such as returnability Resource's schema endpoint
(Section 5.2). (Section 5.2).
A JSON [1] (JavaScript Object Notation) format is defined. Attribute A JSON (JavaScript Object Notation) format [RFC4627] is defined.
names SHOULD be camelCased. SCIM resources represented in JSON MUST Attribute names SHOULD be camelCased. SCIM resources represented in
specify schema via the schemas attribute (Section 5.2). JSON MUST specify schema via the "schemas" attributeSection 5.2.
3.1. Attribute Data Types 3.1. Attribute Data Types
Attribute data types are derived from JSON [2] and unless otherwise Attribute data types are derived from JSON [RFC4627] and unless
specified are optional, modifiable by Consumers, and of type String otherwise specified have the following characteristics (see
(Section 3.1.1). The JSON format defines a limited set of data Section 11 for attribute characteristic definitions):
types, hence, where appropriate, alternate JSON representations
derived from XML schema [3] are defined below. SCIM extensions are optional ("required=false").
SHOULD not introduce new data types.
are case insensitive ("caseExact=false"),
are modifiable ("mutability=readWrite"),
are returned in response to queries ("returned=default"),
are not unique ("uniqueness=none"), and,
of type String (Section 3.1.1).
The JSON format defines a limited set of data types, hence, where
appropriate, alternate JSON representations derived from XML Schema
[XML-Schema] are defined below. SCIM extensions SHOULD NOT introduce
new data types.
3.1.1. String 3.1.1. String
A sequence of zero or more Unicode characters. The JSON format is A sequence of zero or more Unicode characters. The JSON format is
defined in section 2.5 [4] of RFC 4627. A String attribute MAY defined in Section 2.5 [RFC4627] . A "String" attribute MAY specify a
specify a required data format. Additionally, when Canonical Values required data format. Additionally, when canonical values are
are specified Service Providers SHOULD conform to those values if specified service providers SHOULD conform to those values if
appropriate, but MAY provide alternate String values to represent appropriate, but MAY provide alternate "String" values to represent
additional values. additional values.
3.1.2. Boolean 3.1.2. Boolean
The literal "true" or "false". The JSON format is defined in section The literal "true" or "false". The JSON format is defined in
2.1 [5] of RFC 4627. Section 2.1 [RFC4627] .
3.1.3. Decimal 3.1.3. Decimal
A real number with at least one digit to the left and right of the A real number with at least one digit to the left and right of the
period. The JSON format is defined in section 2.4 [6] of RFC 4627. period. The JSON format is defined in Section 2.4 [RFC4627] .
3.1.4. Integer 3.1.4. Integer
A Decimal number with no fractional digits. The JSON format is A decimal number with no fractional digits. The JSON format is
defined in section 2.4 [7] of RFC 4627 with the additional constraint defined in Section 2.4 [RFC4627] with the additional constraint that
that the value MUST NOT contain fractionial or exponent parts. the value MUST NOT contain fractionial or exponent parts.
3.1.5. DateTime 3.1.5. DateTime
A DateTime value (e.g. 2008-01-23T04:56:22Z). The attribute value A DateTime value (e.g. 2008-01-23T04:56:22Z). The attribute value
MUST be encoded as a valid xsd:dateTime as specified in section 3.2.7 MUST be encoded as a valid xsd:dateTime as specified in Section 3.2.7
[8] of the XML Schema Datatypes Specification. [XML-Schema] .
Values represented in JSON MUST conform to the XML constraints above Values represented in JSON MUST conform to the XML constraints above
and are represented as a JSON String [9]. and are represented as a JSON String per Section 2.5 [RFC4627].
3.1.6. Binary 3.1.6. Binary
Arbitrary binary data. The attribute value MUST be encoded as a Arbitrary binary data. The attribute value MUST be encoded as a
valid xsd:base64Binary as specified in section 3.2.16 [10] of the XML valid xsd:base64Binary as specified in Section 3.2.16 [XML-Schema] .
Schema Datatypes Specification.
Values represented in JSON MUST conform to the XML constraints above Values represented in JSON MUST conform to the XML constraints above
and are represented as a JSON String [11]. and are represented as a JSON String perSection 2.5 [RFC4627].
3.1.7. Reference 3.1.7. Reference
A reference to a SCIM Resource. The value MUST be the absolute or A reference to a SCIM resource. The value MUST be the absolute or
relative URI of the target Resource. Relative URIs should be relative URI of the target resource. Relative URIs should be
resolved as specified in section 5.2 [12] of RFC 3986. The base URI resolved as specified in Section 5.2 [RFC3986]. The base URI for
for relative URI resolution MUST include all URI components and path relative URI resolution MUST include all URI components and path
segments up to but not including the Endpoint URI; e.g., the base URI segments up to but not including the Endpoint URI; e.g., the base URI
for a request to https://example.com/v1/Users/2819c223-7f76-453a- for a request to "https://example.com/v2/Users/2819c223-7f76-453a-
919d-413861904646 would be https://example.com/v1/ and the relative 919d-413861904646" would be "https://example.com/v2/" and the
URI for this Resource would be Users/2819c223-7f76-453a- relative URI for this resource would be "Users/2819c223-7f76-453a-
919d-413861904646. 919d-413861904646".
Performing a GET operation on a reference URI MUST return the target Performing a GET operation on a reference URI MUST return the target
Resource or an appropriate HTTP response code. The Service Provider resource or an appropriate HTTP response code. The service provider
MAY optionally choose to enforce referential integrity for MAY optionally choose to enforce referential integrity for
references. references.
By convention, a reference is commonly represented as a "$ref" sub- By convention, a reference is commonly represented as a "$ref" sub-
attribute in complex or multi-valued attributes, however this is attribute in complex or multi-valued attributes, however this is
OPTIONAL. OPTIONAL.
3.1.8. Complex 3.1.8. Complex
A Singular or Multi-valued Attribute whose value is a composition of A singular or multi-valued attribute whose value is a composition of
one or more Simple Attributes. The JSON format is defined in section one or more simple Attributes. The JSON format is defined in
2.2 [13] of RFC 4627. Section 2.2 [RFC4627] .
3.2. Multi-valued Attributes 3.2. Multi-valued Attributes
Multi-valued attributes are unordered lists of attributes. Each Multi-valued attributes are unordered lists of attributes. Each
attribute MAY contain Sub-Attributes and therefore multi-valued attribute MAY contain Sub-Attributes and therefore multi-valued
attributes may contain Complex Attributes. The below Sub-Attributes attributes may contain complex attributes. The sub-attributes below
are considered normative and when specified SHOULD be used as are considered normative and when specified SHOULD be used as
defined. defined.
type A label indicating the attribute's function; e.g., "work" or type A label indicating the attribute's function; e.g., "work" or
"home". "home".
primary A Boolean value indicating the 'primary' or preferred primary A boolean value indicating the 'primary' or preferred
attribute value for this attribute, e.g. the preferred mailing attribute value for this attribute, e.g. the preferred mailing
address or primary e-mail address. The primary attribute value address or primary e-mail address. The primary attribute value
'true' MUST appear no more than once. "true" MUST appear no more than once.
display A human readable name, primarily used for display purposes. display A human readable name, primarily used for display purposes
READ-ONLY. and has a mutability of "immutable".
operation The operation to perform on the multi-valued attribute operation The operation to perform on the multi-valued attribute
during a PATCH request. The only valid value is "delete", which during a PATCH request. The only valid value is "delete", which
signifies that this instance should be removed from the Resource. signifies that this instance should be removed from the resource.
value The attribute's significant value; e.g., the e-mail address, value The attribute's significant value; e.g., the e-mail address,
phone number, etc. Attributes that define a "value" sub-attribute phone number, etc. Attributes that define a "value" sub-attribute
MAY be alternately represented as a collection of primitive types. MAY be alternately represented as a collection of primitive types.
For example: For example:
{ {
"emails": [ "emails": [
{"value":"bjensen@example.com"}, {"value":"bjensen@example.com"},
{"value":"babs@example.com"} {"value":"babs@example.com"}
] ]
} }
May also be represented as: May also be represented as:
{ {
"emails": ["bjensen@example.com","babs@example.com"] "emails": ["bjensen@example.com","babs@example.com"]
} }
$ref The Reference of the target Resource, if the attribute is a $ref The reference URI of the target resource, if the attribute is a
reference. reference.
When returning multi-valued attributes, Service Providers SHOULD When returning multi-valued attributes, service providers SHOULD
canonicalize the value returned, if appropriate (e.g. for e-mail canonicalize the value returned, if appropriate (e.g. for e-mail
addresses and URLs). Providers MAY return the same value more than addresses and URLs). Service providers MAY return the same value
once with different types (e.g. the same e-mail address may used for more than once with different types (e.g. the same e-mail address may
work and home), but SHOULD NOT return the same (type, value) used for work and home), but SHOULD NOT return the same (type, value)
combination more than once per Attribute, as this complicates combination more than once per Attribute, as this complicates
processing by the Consumer. processing by the Consumer.
4. Schema Extension Model 4. Schema Extension Model
SCIM schema follows an object extension model similar to SCIM schema follows an object extension model similar to
ObjectClasses used in LDAP. Unlike LDAP there is no inheritance ObjectClasses used in LDAP. Unlike LDAP there is no inheritance
model; all extensions are additive (similar to LDAP Auxiliary Object model; all extensions are additive (similar to LDAP Auxiliary Object
Classes [14]). Each value indicates additive schema that may exist Class [RFC4512]). Each value indicates additive schema that may
in a SCIM representation as specified by extensions not defined in exist in a SCIM representation as specified by extensions not defined
this suite. Schema extensions MUST NOT redefine any attributes in this suite. Schema extensions MUST NOT redefine any attributes
defined in this specification and SHOULD follow conventions defined defined in this specification and SHOULD follow conventions defined
in this specification. Each schema extension must identify a URI in this specification. Each schema extension must identify a URI
used to identify the extension. The JSON format MUST use the used to identify the extension. The JSON format MUST use the
"schemas" attribute (Section 5.2) to distinguish extended resources "schemas" attributeSection 5.2 to distinguish extended resources and
and attributes. attributes.
5. SCIM Core Schema 5. SCIM Core Schema
5.1. Common Schema Attributes 5.1. Common Schema Attributes
Each SCIM Resource (Users, Groups, etc.) includes the below common Each SCIM resource (Users, Groups, etc.) includes the below common
attributes. These attributes MUST be included in all Resources, attributes. These attributes MUST be included in all resources,
including any extended Resource types. It is not necessary to including any extended resource types. It is not necessary to
specify the schemas attribute if the Resource is fully defined in specify the schemas attribute if the resource is fully defined in
this document as the core schema is implicitly included. this document as the core schema is implicitly included.
id Unique identifier for the SCIM Resource as defined by the Service id Unique identifier for the SCIM resource as defined by the service
Provider. Each representation of the Resource MUST include a non- provider. Each representation of the resource MUST include a non-
empty id value. This identifier MUST be unique across the Service empty "id" value. This identifier MUST be unique across the
Provider's entire set of Resources. It MUST be a stable, non- service provider's entire set of resources. It MUST be a stable,
reassignable identifier that does not change when the same non-reassignable identifier that does not change when the same
Resource is returned in subsequent requests. The value of the id resource is returned in subsequent requests. The value of the
attribute is always issued by the Service Provider and MUST never "id" attribute is always issued by the service provider and MUST
be specified by the Service Consumer. bulkId: is a reserved never be specified by the client. bulkId: is a reserved keyword
keyword and MUST NOT be used in the unique identifier. REQUIRED and MUST NOT be used in the unique identifier. REQUIRED and has a
and READ-ONLY. mutability of "readOnly".
externalId An identifier for the Resource as defined by the Service externalId An identifier for the resource as defined by the client.
Consumer. The externalId may simplify identification of the The "externalId" may simplify identification of the resource
Resource between Service Consumer and Service provider by allowing between client and service provider by allowing the client to
the Consumer to refer to the Resource with its own identifier, refer to the resource with its own identifier, obviating the need
obviating the need to store a local mapping between the local to store a local mapping between the local identifier of the
identifier of the Resource and the identifier used by the Service resource and the identifier used by the service provider. Each
Provider. Each Resource MAY include a non-empty externalId value. resource MAY include a non-empty externalId value. The value of
The value of the externalId attribute is always issued be the the "externalId" attribute is always issued by the client and can
Service Consumer and can never be specified by the Service never be specified by the service provider. The service provider
Provider. The Service Provider MUST always interpret the MUST always interpret the externalId as scoped to the client's
externalId as scoped to the Service Consumer's tenant. tenant.
meta A complex attribute containing resource metadata. All sub- meta A complex attribute containing resource metadata. All sub-
attributes are OPTIONAL attributes are OPTIONAL
resourceType The name of the Resource Type of the Resource. resourceType The name of the resource type of the resource.
READ-ONLY. Attribute has mutability of "readOnly".
created The DateTime the Resource was added to the Service created The DateTime the resource was added to the service
Provider. The attribute MUST be a DateTime. READ-ONLY. provider. The attribute MUST be a DateTime. Attribute has
mutability of "readOnly".
lastModified The most recent DateTime the details of this lastModified The most recent DateTime the details of this
Resource were updated at the Service Provider. If this resource were updated at the service provider. If this
Resource has never been modified since its initial creation, resource has never been modified since its initial creation,
the value MUST be the same as the value of created. The the value MUST be the same as the value of created. The
attribute MUST be a DateTime. READ-ONLY. attribute MUST be a DateTime. Attribute has mutability of
"readOnly".
location The URI of the Resource being returned. This value MUST location The URI of the resource being returned. This value MUST
be the same as the Location HTTP response header. READ- be the same as the Location HTTP response header. Attribute
ONLY. has mutability of "readOnly".
version The version of the Resource being returned. This value version The version of the resource being returned. This value
must be the same as the ETag HTTP response header. READ- must be the same as the ETag HTTP response header. Attribute
ONLY. has mutability of "readOnly".
attributes The names of the attributes to remove from the attributes The names of the attributes to remove from the
Resource during a PATCH operation. resource during a PATCH operation.
5.2. "schemas" Attribute 5.2. "schemas" Attribute
SCIM supports resources of different types, with extensible schemas. SCIM supports resources of different types, with extensible schemas.
Each resource MUST be indicated using fully qualified URLs. Each resource MUST be indicated using fully qualified URLs.
When a representation does not explicitly provide support for A "schemas" attribute is used to indicate the version of SCIM schema
indicating a schema, such as JSON, a schemas attribute is used to as well as any schema extensions.
indicate the version of SCIM schema as well as any schema extensions.
schemas The schemas attribute is an array of Strings which allows schemas The schemas attribute is an array of strings which allows
introspection of the supported schema version for a SCIM introspection of the supported schema version for a SCIM
representation as well any schema extensions supported by that representation as well any schema extensions supported by that
representation. Each String value must be a unique URI. This representation. Each String value must be a unique URI. This
specification defines URIs for User, Group, and a standard specification defines URIs for User, Group, and a standard
"enterprise" extension. All representations of SCIM schema MUST enterprise-user extension. All representations of SCIM schema
include a non-zero value array with value(s) of the URIs supported MUST include a non-zero value array with value(s) of the URIs
by that representation. The schemas attribute for a Resource MUST supported by that representation. The schemas attribute for a
only contain values defined as "schema" and "schemaExtensions" for resource MUST only contain values defined as "schema" and
the Resource's Resource Type. Duplicate values MUST NOT be "schemaExtensions" for the resource's resource type. Duplicate
included. Value order is not specified and MUST not impact values MUST NOT be included. Value order is not specified and
behavior. REQUIRED. MUST not impact behavior. REQUIRED.
6. SCIM User Schema 6. SCIM User Schema
SCIM provides a schema for representing Users, identified using the SCIM provides a schema for representing Users, identified using the
following URI: 'urn:scim:schemas:core:2.0:User'. The following following URI: "urn:scim:schemas:core:2.0:User". The following
attributes are defined in addition to those attributes defined in attributes are defined in addition to those attributes defined in
SCIM Core Schema: SCIM Core Schema:
6.1. Singular Attributes 6.1. Singular Attributes
userName Unique identifier for the User, typically used by the user userName Unique identifier for the user, typically used by the user
to directly authenticate to the service provider. Often displayed to directly authenticate to the service provider. Often displayed
to the user as their unique identifier within the system (as to the user as their unique identifier within the system (as
opposed to id or externalId, which are generally opaque and not opposed to id or externalId, which are generally opaque and not
user-friendly identifiers). Each User MUST include a non-empty user-friendly identifiers). Each User MUST include a non-empty
userName value. This identifier MUST be unique across the Service userName value. This identifier MUST be unique across the
Consumer's entire set of Users. REQUIRED. client's entire set of Users. RECOMMENDED.
name The components of the User's real name. Providers MAY return name The components of the user's real name. Service providers MAY
just the full name as a single string in the formatted sub- return just the full name as a single string in the formatted sub-
attribute, or they MAY return just the individual component attribute, or they MAY return just the individual component
attributes using the other sub-attributes, or they MAY return attributes using the other sub-attributes, or they MAY return
both. If both variants are returned, they SHOULD be describing both. If both variants are returned, they SHOULD be describing
the same name, with the formatted name indicating how the the same name, with the formatted name indicating how the
component attributes should be combined. component attributes should be combined.
formatted The full name, including all middle names, titles, and formatted The full name, including all middle names, titles, and
suffixes as appropriate, formatted for display (e.g. Ms. suffixes as appropriate, formatted for display (e.g. "Ms.
Barbara Jane Jensen, III.). Barbara Jane Jensen, III.").
familyName The family name of the User, or "Last Name" in most familyName The family name of the User, or last name in most
Western languages (e.g. Jensen given the full name Ms. Western languages (e.g. "Jensen" given the full name "Ms.
Barbara Jane Jensen, III.). Barbara Jane Jensen, III.").
givenName The given name of the User, or "First Name" in most givenName The given name of the User, or first name in most
Western languages (e.g. Barbara given the full name Ms. Western languages (e.g. "Barbara" given the full name "Ms.
Barbara Jane Jensen, III.). Barbara Jane Jensen, III.").
middleName The middle name(s) of the User (e.g. Jane given the middleName The middle name(s) of the User (e.g. "Jane" given the
full name Ms. Barbara Jane Jensen, III.). full name "Ms. Barbara Jane Jensen, III.").
honorificPrefix The honorific prefix(es) of the User, or "Title" honorificPrefix The honorific prefix(es) of the User, or title in
in most Western languages (e.g. Ms. given the full name Ms. most Western languages (e.g. "Ms." given the full name "Ms.
Barbara Jane Jensen, III.). Barbara Jane Jensen, III.").
honorificSuffix The honorific suffix(es) of the User, or "Suffix" honorificSuffix The honorific suffix(es) of the User, or suffix
in most Western languages (e.g. III. given the full name Ms. in most Western languages (e.g. "III." given the full name "Ms.
Barbara Jane Jensen, III.). Barbara Jane Jensen, III.").
displayName The name of the User, suitable for display to end-users. displayName The name of the user, suitable for display to end-users.
Each User returned MAY include a non-empty displayName value. The Each user returned MAY include a non-empty displayName value. The
name SHOULD be the full name of the User being described if known name SHOULD be the full name of the User being described if known
(e.g. Babs Jensen or Ms. Barbara J Jensen, III), but MAY be a (e.g. "Babs Jensen" or "Ms. Barbara J Jensen, III"), but MAY be a
username or handle, if that is all that is available (e.g. username or handle, if that is all that is available (e.g.
bjensen). The value provided SHOULD be the primary textual label "bjensen"). The value provided SHOULD be the primary textual
by which this User is normally displayed by the Service Provider label by which this User is normally displayed by the service
when presenting it to end-users. provider when presenting it to end-users.
nickName The casual way to address the user in real life, e.g. "Bob" nickName The casual way to address the user in real life, e.g. "Bob"
or "Bobby" instead of "Robert". This attribute SHOULD NOT be used or "Bobby" instead of "Robert". This attribute SHOULD NOT be used
to represent a User's username (e.g. bjensen or mpepperidge). to represent a User's username (e.g. bjensen or mpepperidge).
profileUrl A fully qualified URL to a page representing the User's profileUrl A fully qualified URL to a page representing the user's
online profile. online profile.
title The user's title, such as "Vice President." title The user's title, such as "Vice President".
userType Used to identify the organization to user relationship. userType Used to identify the organization to user relationship.
Typical values used might be "Contractor", "Employee", "Intern", Typical values used might be "Contractor", "Employee", "Intern",
"Temp", "External", and "Unknown" but any value may be used. "Temp", "External", and "Unknown" but any value may be used.
preferredLanguage Indicates the User's preferred written or spoken preferredLanguage Indicates the user's preferred written or spoken
language. Generally used for selecting a localized User language. Generally used for selecting a localized User
interface. Valid values are concatenation of the ISO 639-1 two interface. Valid values are concatenation of the ISO 639-1 two
letter language code [15], an underscore, and the ISO 3166-1 2 letter language code per [ISO639-2], an underscore, and the ISO
letter country code [16]; e.g., 'en_US' specifies the language 3166-1 2 letter country code[ISO3166]; e.g., 'en_US' specifies the
English and country US. language English and country US.
locale Used to indicate the User's default location for purposes of locale Used to indicate the User's default location for purposes of
localizing items such as currency, date time format, numerical localizing items such as currency, date time format, numerical
representations, etc. A locale value is a concatenation of the representations, etc. A locale value is a concatenation of the
ISO 639-1 two letter language code [17], an underscore, and the ISO 639-1 two letter language code[ISO639-2], an underscore, and
ISO 3166-1 2 letter country code [18]; e.g., 'en_US' specifies the the ISO 3166-1 2 letter country code[ISO3166]; e.g., 'en_US'
language English and country US. specifies the language English and country US.
timezone The User's time zone in the "Olson" timezone database timezone The User's time zone in the "Olson" timezone database
format [19]; e.g.,'America/Los_Angeles'. format[Olson-TZ]; e.g.,'America/Los_Angeles'.
active A Boolean value indicating the User's administrative status. active A Boolean value indicating the user's administrative status.
The definitive meaning of this attribute is determined by the The definitive meaning of this attribute is determined by the
Service Provider though a value of true infers the User is, for service provider. As a typical example, a value of true infers
example, able to login while a value of false implies the User's the user is able to login while a value of false implies the
account has been suspended. user's account has been suspended.
password The User's clear text password. This attribute is intended password The user's clear text password. This attribute is intended
to be used as a means to specify an initial password when creating to be used as a means to specify an initial password when creating
a new User or to reset an existing User's password. No accepted a new User or to reset an existing User's password. Password
standards exist to convey password policies, hence Consumers policies and the ability to update or set passwords are out of
should expect Service Providers to reject password values. This scope of this document. The mutability of this attribute is
value MUST never be returned by a Service Provider in any form. "writeOnly" indicating the value MUST NOT be returned by a service
provider in any form.
6.2. Multi-valued Attributes 6.2. Multi-valued Attributes
The following multi-valued attributes are defined. The following multi-valued attributes are defined.
emails E-mail addresses for the User. The value SHOULD be emails E-mail addresses for the User. The value SHOULD be
canonicalized by the Service Provider, e.g. bjensen@example.com canonicalized by the service provider, e.g. "bjensen@example.com"
instead of bjensen@EXAMPLE.COM. Canonical Type values of work, instead of "bjensen@EXAMPLE.COM". Canonical type values of
home, and other. "work", "home", and "other".
phoneNumbers Phone numbers for the User. The value SHOULD be phoneNumbers Phone numbers for the user. The value SHOULD be
canonicalized by the Service Provider according to format in canonicalized by the service provider according to format in
RFC3966 [20] e.g. 'tel:+1-201-555-0123'. Canonical Type values of [RFC3966] e.g. 'tel:+1-201-555-0123'. Canonical type values of
work, home, mobile, fax, pager and other. "work", "home", "mobile", "fax", "pager", and "other".
ims Instant messaging address for the User. No official ims Instant messaging address for the user. No official
canonicalization rules exist for all instant messaging addresses, canonicalization rules exist for all instant messaging addresses,
but Service Providers SHOULD, when appropriate, remove all but service providers SHOULD, when appropriate, remove all
whitespace and convert the address to lowercase. Instead of the whitespace and convert the address to lowercase. Instead of the
standard Canonical Values for type, this attribute defines the standard canonical values for type, this attribute defines the
following Canonical Values to represent currently popular IM following canonical values to represent currently popular IM
services: aim, gtalk, icq, xmpp, msn, skype, qq, and yahoo. services: "aim", "gtalk", "icq", "xmpp", "msn", "skype", "qq",
"yahoo", and "other".
photos URL of a photo of the User. The value SHOULD be a photos URL of a photo of the User. The value SHOULD be a
canonicalized URL, and MUST point to an image file (e.g. a GIF, canonicalized URL, and MUST point to an image file (e.g. a GIF,
JPEG, or PNG image file) rather than to a web page containing an JPEG, or PNG image file) rather than to a web page containing an
image. Service Providers MAY return the same image at different image. Service providers MAY return the same image at different
sizes, though it is recognized that no standard for describing sizes, though it is recognized that no standard for describing
images of various sizes currently exists. Note that this images of various sizes currently exists. Note that this
attribute SHOULD NOT be used to send down arbitrary photos taken attribute SHOULD NOT be used to send down arbitrary photos taken
by this User, but specifically profile photos of the User suitable by this user, but specifically profile photos of the user suitable
for display when describing the User. Instead of the standard for display when describing the user. Instead of the standard
Canonical Values for type, this attribute defines the following canonical values for type, this attribute defines the following
Canonical Values to represent popular photo sizes: photo, canonical values to represent popular photo sizes: "photo",
thumbnail. "thumbnail".
addresses A physical mailing address for this User. Canonical Type addresses A physical mailing address for this user. Canonical type
Values of work, home, and other. The value attribute is a complex values of "work", "home", and "other". The value attribute is a
type with the following sub-attributes. All Sub-Attributes are complex type with the following sub-attributes. All sub-
OPTIONAL. attributes are OPTIONAL.
formatted The full mailing address, formatted for display or use formatted The full mailing address, formatted for display or use
with a mailing label. This attribute MAY contain newlines. with a mailing label. This attribute MAY contain newlines.
streetAddress The full street address component, which may streetAddress The full street address component, which may
include house number, street name, P.O. box, and multi-line include house number, street name, P.O. box, and multi-line
extended street address information. This attribute MAY extended street address information. This attribute MAY
contain newlines. contain newlines.
locality The city or locality component. locality The city or locality component.
region The state or region component. region The state or region component.
postalCode The zipcode or postal code component. postalCode The zipcode or postal code component.
country The country name component. When specified the value country The country name component. When specified the value
MUST be in ISO 3166-1 alpha 2 "short" code format [21]; MUST be in ISO 3166-1 alpha 2 "short" code format[ISO3166];
e.g., the United States and Sweden are "US" and "SE", e.g., the United States and Sweden are "US" and "SE",
respectively. respectively.
groups A list of groups that the user belongs to, either thorough groups A list of groups that the user belongs to, either thorough
direct membership, nested groups, or dynamically calculated. The direct membership, nested groups, or dynamically calculated. The
values are meant to enable expression of common group or role values are meant to enable expression of common group or role
based access control models, although no explicit authorization based access control models, although no explicit authorization
model is defined. It is intended that the semantics of group model is defined. It is intended that the semantics of group
membership and any behavior or authorization granted as a result membership and any behavior or authorization granted as a result
of membership are defined by the Service Provider. The Canonical of membership are defined by the service provider. The canonical
types "direct" and "indirect" are defined to describe how the types "direct" and "indirect" are defined to describe how the
group membership was derived. Direct group membership indicates group membership was derived. Direct group membership indicates
the User is directly associated with the group and SHOULD indicate the user is directly associated with the group and SHOULD indicate
that Consumers may modify membership through the Group Resource. that clients may modify membership through the "Group" resource.
Indirect membership indicates User membership is transitive or Indirect membership indicates user membership is transitive or
dynamic and implies that Consumers cannot modify indirect group dynamic and implies that clients cannot modify indirect group
membership through the Group resource but MAY modify direct group membership through the "Group" resource but MAY modify direct
membership through the Group resource which MAY influence indirect group membership through the "Group" resource which MAY influence
memberships. If the SCIM Service Provider exposes a Group indirect memberships. If the SCIM service provider exposes a
resource, the "value" sub-attribute MUST be the "id" and the Group resource, the "value" sub-attribute MUST be the "id" and the
"$ref" sub-attribute must be the URI of the corresponding Group "$ref" sub-attribute must be the URI of the corresponding "Group"
resources to which the user belongs. Since this attribute is resources to which the user belongs. Since this attribute has a
read-only, group membership changes MUST be applied via the Group mutability of "readOnly", group membership changes MUST be applied
Resource (Section 8). READ-ONLY. via the Group Resource (Section 8). The attribute has a
mutability of "readOnly".
entitlements A list of entitlements for the User that represent a entitlements A list of entitlements for the user that represent a
thing the User has. That is, an entitlement is an additional thing the user has. An entitlement MAY be an additional right to
right to a thing, object or service. No vocabulary or syntax is a thing, object, or service. No vocabulary or syntax is specified
specified and Service Providers/Consumers are expected to encode and service providers and clients are expected to encode
sufficient information in the value so as to accurately and sufficient information in the value so as to accurately and
without ambiguity determine what the User has access to. This without ambiguity determine what the user has access to. This
value has NO canonical types though type may be useful as a means value has NO canonical types though type may be useful as a means
to scope entitlements. to scope entitlements.
roles A list of roles for the User that collectively represent who roles A list of roles for the user that collectively represent who
the User is; e.g., 'Student', "Faculty". No vocabulary or syntax the user is; e.g., "Student, Faculty". No vocabulary or syntax is
is specified though it is expected that a role value is a String specified though it is expected that a role value is a String or
or label representing a collection of entitlements. This value label representing a collection of entitlements. This value has
has NO canonical types. NO canonical types.
x509Certificates A list of certificates issued to the User. Values x509Certificates A list of certificates issued to the User. Values
are Binary (Section 3.1.6) and DER encoded x509. This value has are Binary (Section 3.1.6) and DER encoded x509. This value has
NO canonical types. NO canonical types.
7. SCIM Enterprise User Schema Extension 7. SCIM Enterprise User Schema Extension
The following SCIM extension defines attributes commonly used in The following SCIM extension defines attributes commonly used in
representing users that belong to, or act on behalf of a business or representing users that belong to, or act on behalf of a business or
enterprise. The enterprise user extension is identified using the enterprise. The enterprise user extension is identified using the
following URI: 'urn:scim:schemas:extension:enterprise:2.0:User'. following schema URI:
"urn:scim:schemas:extension:enterprise:2.0:User".
The following Singular Attributes are defined: The following Singular Attributes are defined:
employeeNumber Numeric or alphanumeric identifier assigned to a employeeNumber Numeric or alphanumeric identifier assigned to a
person, typically based on order of hire or association with an person, typically based on order of hire or association with an
organization. organization.
costCenter Identifies the name of a cost center. costCenter Identifies the name of a cost center.
organization Identifies the name of an organization. organization Identifies the name of an organization.
division Identifies the name of a division. division Identifies the name of a division.
department Identifies the name of a department. department Identifies the name of a department.
manager The User's manager. A complex type that optionally allows manager The user's manager. A complex type that optionally allows
Service Providers to represent organizational hierarchy by service providers to represent organizational hierarchy by
referencing the "id" attribute of another User. referencing the "id" attribute of another User.
managerId The id of the SCIM resource representing the User's value The "id" of the SCIM resource representing the user's
manager. REQUIRED. manager. RECOMMENDED.
$ref The URI of the SCIM resource representing the User's $ref The URI of the SCIM resource representing the User's
manager. REQUIRED. manager. RECOMMENDED.
displayName The displayName of the User's manager. OPTIONAL and displayName The displayName of the user's manager. This
READ-ONLY. attribute is OPTIONAL and mutability is "readOnly".
8. SCIM Group Schema 8. SCIM Group Schema
SCIM provides a schema for representing groups, identified using the SCIM provides a schema for representing groups, identified using the
following URI: 'urn:scim:schemas:core:2.0:Group'. following schema URI: "urn:scim:schemas:core:2.0:Group".
Group resources are meant to enable expression of common Group or Group resources are meant to enable expression of common group or
role based access control models, although no explicit authorization role based access control models, although no explicit authorization
model is defined. It is intended that the semantics of group model is defined. It is intended that the semantics of group
membership and any behavior or authorization granted as a result of membership and any behavior or authorization granted as a result of
membership are defined by the Service Provider are considered out of membership are defined by the service provider are considered out of
scope for this specification. scope for this specification.
The following Singular Attribute is defined in addition to the common The following singular attribute is defined in addition to the common
attributes defined in SCIM Core Schema: attributes defined in SCIM core schema:
displayName A human readable name for the Group. REQUIRED. displayName A human readable name for the Group. REQUIRED.
The following multi-valued attribute is defined in addition to the The following multi-valued attribute is defined in addition to the
common attributes defined in SCIM Core Schema: common attributes defined in SCIM Core Schema:
members A list of members of the Group. Canonical Types "User" and members A list of members of the Group. While values MAY be added
"Group" are READ-ONLY. The "value" sub-attribute must be the "id" or removed, sub-attributes of members are "immutable". The
and the "$ref" sub-attribute must be the URI of a SCIM resource, "value" sub-attribute must be the "id" and the "$ref" sub-
either a User, or a Group. The intention of the Group type is to attribute must be the URI of a SCIM resource, either a "User", or
allow the Service Provider to support nested Groups. Service a "Group". The intention of the "Group" type is to allow the
Providers MAY require Consumers to provide a non-empty members service provider to support nested groups. Service providers MAY
value based on the "required" sub attribute of the "members" require clients to provide a non-empty members value based on the
attribute in Group Resource Schema. "required" sub attribute of the "members" attribute in the "Group"
resource schema.
9. Service Provider Configuration Schema 9. Service Provider Configuration Schema
SCIM provides a schema for representing the Service Provider's SCIM provides a schema for representing the service provider's
configuration identified using the following URI: configuration identified using the following schema URI:
'urn:scim:schemas:core:2.0:ServiceProviderConfig' "urn:scim:schemas:core:2.0:ServiceProviderConfig"
The Service Provider Configuration Resource enables a Service The service provider configuration resource enables a service
Provider to expose its compliance with the SCIM specification in a provider to discovery of SCIM specification features in a
standardized form as well as provide additional implementation standardized form as well as provide additional implementation
details to Consumers. All attributes are READ-ONLY. Unlike other details to clients. All attributes are READ-ONLY (a mutability of
core Resources, the "id" attribute is not required for the Service "readOnly"). Unlike other core resources, the "id" attribute is not
Provider Configuration Resource. required for the service provider configuration resource.
The following Singular Attributes are defined in addition to the The following Singular Attributes are defined in addition to the
common attributes defined in Core Schema: common attributes defined in Core Schema:
documentationUrl An HTTP addressable URL pointing to the Service documentationUrl An HTTP addressable URL pointing to the service
Provider's human consumable help documentation. provider's human consumable help documentation.
patch A complex type that specifies PATCH configuration options. patch A complex type that specifies PATCH configuration options.
REQUIRED. REQUIRED.
supported Boolean value specifying whether the operation is supported Boolean value specifying whether the operation is
supported. REQUIRED. supported. REQUIRED.
bulk A complex type that specifies BULK configuration options. bulk A complex type that specifies BULK configuration options.
REQUIRED REQUIRED
supported Boolean value specifying whether the operation is supported Boolean value specifying whether the operation is
supported. REQUIRED. supported. REQUIRED.
maxOperations An integer value specifying the maximum number of maxOperations An integer value specifying the maximum number of
operations. REQUIRED. operations. REQUIRED.
maxPayloadSize An integer value specifying the maximum payload maxPayloadSize An integer value specifying the maximum payload
size in bytes. REQUIRED. size in bytes. REQUIRED.
filter A complex type that specifies FILTER options. REQUIRED. filter A complex type that specifies FILTER options. REQUIRED.
supported Boolean value specifying whether the operation is supported Boolean value specifying whether the operation is
supported. REQUIRED. supported. REQUIRED.
maxResults Integer value specifying the maximum number of maxResults Integer value specifying the maximum number of
Resources returned in a response. REQUIRED. resources returned in a response. REQUIRED.
changePassword A complex type that specifies Change Password changePassword A complex type that specifies Change Password
configuration options. REQUIRED. configuration options. REQUIRED.
supported Boolean value specifying whether the operation is supported Boolean value specifying whether the operation is
supported. REQUIRED. supported. REQUIRED.
sort A complex type that specifies Sort configuration options. sort A complex type that specifies Sort configuration options.
REQUIRED. REQUIRED.
supported Boolean value specifying whether sorting is supported. supported Boolean value specifying whether sorting is supported.
REQUIRED. REQUIRED.
etag A complex type that specifies Etag configuration options. etag A complex type that specifies Etag configuration options.
REQUIRED. REQUIRED.
supported Boolean value specifying whether the operation is supported Boolean value specifying whether the operation is
supported. REQUIRED. supported. REQUIRED.
The following multi-valued attribute is defined in addition to the The following multi-valued attribute is defined in addition to the
common attributes defined in Core Schema: common attributes defined in core schema:
authenticationSchemes A complex type that specifies supported authenticationSchemes A complex type that specifies supported
Authentication Scheme properties. Instead of the standard Authentication Scheme properties. This attribute defines the
Canonical Values for type, this attribute defines the following following canonical values to represent common schemes: "oauth",
Canonical Values to represent common schemes: oauth, oauth2, "oauth2", "oauthbearertoken", "httpbasic", and "httpdigest". To
oauthbearertoken, httpbasic, and httpdigest. To enable seamless enable seamless discovery of configuration, the service provider
discovery of configuration, the Service Provider SHOULD, with the SHOULD, with the appropriate security considerations, make the
appropriate security considerations, make the
authenticationSchemes attribute publicly accessible without prior authenticationSchemes attribute publicly accessible without prior
authentication. REQUIRED. authentication. REQUIRED.
name The common authentication scheme name; e.g., HTTP Basic. name The common authentication scheme name; e.g., HTTP Basic.
REQUIRED. REQUIRED.
description A description of the Authentication Scheme. description A description of the Authentication Scheme.
REQUIRED. REQUIRED.
specUrl A HTTP addressable URL pointing to the Authentication specUrl A HTTP addressable URL pointing to the Authentication
Scheme's specification. OPTIONAL. Scheme's specification. OPTIONAL.
documentationUrl A HTTP addressable URL pointing to the documentationUrl A HTTP addressable URL pointing to the
Authentication Scheme's usage documentation. OPTIONAL. Authentication Scheme's usage documentation. OPTIONAL.
10. Resource Type Schema 10. ResourceType Schema
The Resource Type schema specifies the meta-data about a Resource The "ResourceType" schema specifies the meta-data about a resource
Type. Resource Type Resources are READ-ONLY and identified using the type. Resource type resources are READ-ONLY and identified using the
following URI: 'urn:scim:schemas:core:2.0:ResourceType'. Unlike following schema URI: "urn:scim:schemas:core:2.0:ResourceType".
other core Resources, all Attributes are REQUIRED unless otherwise Unlike other core resources, all attributes are REQUIRED unless
specified, and the "id" attribute is not required for the Resource otherwise specified. The "id" attribute is not required for the
Type Resource. resource type resource.
The following Singular Attributes are defined: The following Singular Attributes are defined:
name The Resource Type name. When applicable Service Providers MUST id The resource type's server unique id. Often this is the same
value as the "name" attribute. OPTIONAL
name The resource type name. When applicable service providers MUST
specify the name specified in the core schema specification; e.g., specify the name specified in the core schema specification; e.g.,
"User" or "Group". This name is referenced by the "User" or "Group". This name is referenced by the
meta.resourceType attribute in all resources. "meta.resourceType" attribute in all resources.
description The Resource Type's human readable description. When description The resource type's human readable description. When
applicable Service Providers MUST specify the description applicable service providers MUST specify the description
specified in the core schema specification. specified in the core schema specification.
endpoint The Resource Type's HTTP addressable endpoint relative to endpoint The resource type's HTTP addressable endpoint relative to
the Base URL; e.g., /Users. the Base URL; e.g., "/Users".
schema The Resource Type's primary schema URI; e.g., schema The resource type's primary schema URI; e.g.,
urn:scim:schemas:core:2.0:User. This MUST be equal to the "id" "urn:scim:schemas:core:2.0:User". This MUST be equal to the "id"
attribute of the Schema. attribute of the associated "Schema" resource.
schemaExtensions A list of URIs of the Resource Type's schema schemaExtensions A list of URIs of the resource type's schema
extensions. OPTIONAL. extensions. OPTIONAL.
schema The URI of an extended schema; e.g., urn:edu:2.0:Staff. schema The URI of an extended schema; e.g., "urn:edu:2.0:Staff".
This MUST be equal to the "id" attribute of a Schema. This MUST be equal to the "id" attribute of a "Schema"
REQUIRED. resource. REQUIRED.
required A Boolean value that specifies whether the schema required A Boolean value that specifies whether the schema
extension is required for the Resource Type. If true, a extension is required for the resource type. If true, a
Resource of this type MUST include this schema extension and resource of this type MUST include this schema extension and
include any attributes declared as required in this schema include any attributes declared as required in this schema
extension. If false, a Resource of this type MAY omit this extension. If false, a resource of this type MAY omit this
schema extension. REQUIRED. schema extension. REQUIRED.
11. Schema Schema 11. Schema Schema
The Schema schema specifies the Attribute(s) and meta-data that The "Schema" schema specifies the attribute(s) and meta-data that
constitute a Schema. Schema Resources are READ-ONLY and identified constitute a "Schema" resource. Schema resources have mutability of
using the following URI: 'urn:scim:schemas:core:2.0:Schema'. Unlike "readOnly" and identified using the following URI:
other core Resources the Schema Resource MAY contain a complex object "urn:scim:schemas:core:2.0:Schema". Unlike other core resources the
within a Sub-Attribute and all Attributes are REQUIRED unless other "Schema" resource MAY contain a complex object within a sub-attribute
specified. and all attributes are REQUIRED unless otherwise specified.
The following Singular Attributes are defined: The following Singular Attributes are defined:
id The unique URI of the schema. When applicable Service Providers id The unique URI of the schema. When applicable service providers
MUST specify the URI specified in the core schema specification; MUST specify the URI specified in the core schema specification;
e.g., "urn:scim:core:2.0:User". Unlike most other schemas, which e.g., "urn:scim:schemas:core:2.0:User". Unlike most other
use some sort of a GUID for the "id", the Schema "id" is a URI so schemas, which use some sort of a GUID for the "id", the schema
that it can be registered and is portable between different "id" is a URI so that it can be registered and is portable between
Service Providers and Clients. different service providers and clients.
name The Schema's human readable name. When applicable Service name The schema's human readable name. When applicable service
Providers MUST specify the name specified in the core schema providers MUST specify the name specified in the core schema
specification; e.g., "User" or "Group". OPTIONAL. specification; e.g., "User" or "Group". OPTIONAL.
description The Schema's human readable description. When description The schema's human readable description. When
applicable Service Providers MUST specify the description applicable service providers MUST specify the description
specified in the core schema specification. OPTIONAL. specified in the core schema specification. OPTIONAL.
The following multi-valued attribute is defined: The following multi-valued attribute is defined:
attributes A complex type that specifies the set of Resource attributes A complex type that specifies the set of resource
attributes. attributes.
name The attribute's name. name The attribute's name.
type The attribute's data type; e.g., String. type The attribute's data type; e.g., "String".
multiValued Boolean value indicating the attribute's plurality. multiValued Boolean value indicating the attribute's plurality.
description The attribute's human readable description. When description The attribute's human readable description. When
applicable Service Providers MUST specify the description applicable service providers MUST specify the description
specified in the core schema specification. specified in the core schema specification.
readOnly A Boolean value that specifies if the attribute is
mutable.
required A Boolean value that specifies if the attribute is required A Boolean value that specifies if the attribute is
required. required.
caseExact A Boolean value that specifies if the String attribute caseExact A Boolean value that specifies if the String attribute
is case sensitive. is case sensitive.
referenceTypes The names of the Resource Types that may be mutability A single keyword indicating what types of
modifications an attribute MAY accept as follows:
readOnly The attribute MAY NOT be modified.
readWrite The attribute MAY be updated and read at any time.
DEFAULT.
immutable The attribute MAY be defined at resource creation
(e.g. POST) or at record replacement via request (e.g. a
PUT). The attribute MAY NOT be updated.
writeOnly The attribute MAY be updated at any time. Attribute
values MAY NOT be returned (e.g. because the value is a
stored hash). Note: an attribute with mutability of
"writeOnly" usually also has a returned setting of "never".
returned A single keyword that indicates when an attribute and
associated values are returned in response to a GET request or
in response to a PUT, POST, or PATCH request. Valid keywords
are:
always The attribute is always returned regardless of the
contents of the "attributes" parameter. For example, "id"
is always returned to identify a SCIM resource.
never The attribute is never returned. This may occur because
the original attribute value is not retained by the service
provider (e.g. such as with a hashed value). A service
provider MAY allow attributes to be used in a search filter.
default The attribute is returned by default in all SCIM
operation responses where attribute values are returned. If
the GET request "attributes" parameter is specified,
attribute values are only returned if the attribute is named
in the attributes parameter. DEFAULT.
request The attribute is returned in response to any PUT,
POST, or PATCH operations if the attribute was specified by
the client (for example, the attribute was modified). The
attribute is returned in a SCIM query operation only if
specified in the "attributes" parameter.
uniqueness A single keyword value that specifies how the service
provider enforces uniqueness of attribute values. A server MAY
reject an invalid value based on uniqueness by returning HTTP
Response code 400 (Bad Request). A client MAY enforce
uniqueness on the client-side to a greater degree than the
service provider enforces. For example, a client could make a
value unique while the server has uniqueness of "none". Valid
keywords are:
none The values are not intended to be unique in any way.
DEFAULT.
server The value SHOULD be unique within the context of the
current SCIM endpoint (or tenancy) but MAY not be globally
unique (e.g. a "username", email address, or other server
generated key or counter). No two resources on the same
server SHOULD possess the same value.
global The value SHOULD be globally unique (e.g. an email
address, a GUID, or other value). No two resources on any
server SHOULD possess the same value.
referenceTypes The names of the resource types that may be
referenced; e.g., "User". This is only applicable for
attributes that are of the "reference" Section 3.1.7 data type.
The following multi-valued attributes are defined. There are
no canonical type values defined and the primary value serves
no useful purpose.
name The attribute's name.
type The attribute's data type; e.g., String.
description The attribute's human readable description. When
applicable service providers MUST specify the description
specified in the core schema specification.
required A Boolean value that specifies if the attribute is
required.
caseExact A Boolean value that specifies if the String
attribute is case sensitive.
referenceTypes The names of the resource types that may be
referenced; e.g., User. This is only applicable for referenced; e.g., User. This is only applicable for
attributes that are of the "reference" data type. attributes that are of the "reference" Section 3.1.7 data
type.
The following multi-valued attributes are defined. There canonicalValues A collection of canonical values. When
are no canonical type values defined and the primary value applicable service providers MUST specify the canonical
serves no useful purpose. types specified in the core schema specification;
e.g.,"work","home". OPTIONAL.
subAttributes A list specifying the contained attributes. mutability A single keyword indicating what types of
OPTIONAL. modifications an attribute MAY accept as follows:
name The attribute's name. readOnly The attribute MAY NOT be modified.
type The attribute's data type; e.g., readWrite The attribute MAY be updated and read at any
String. time. DEFAULT.
description The attribute's human readable immutable The attribute MAY be defined at resource creation
description. When applicable Service (e.g. POST) or at record replacement via request (e.g. a
Providers MUST specify the description PUT). The attribute MAY NOT be updated.
specified in the core schema
specification.
readOnly A Boolean value that specifies if the writeOnly The attribute MAY be updated at any time.
attribute is mutable. Attribute values MAY NOT be returned (e.g. because the
value is a stored hash). Note: an attribute with
mutability of "writeOnly" usually also has a returned
setting of "never".
required A Boolean value that specifies if the returned A single keyword that indicates when an attribute and
attribute is required. associated values are returned in response to a GET request
or in response to a PUT, POST, or PATCH request. Valid
keywords are:
caseExact A Boolean value that specifies if the always The attribute is always returned regardless of the
String attribute is case sensitive. contents of the "attributes" parameter. For example,
"id" is always returned to identify a SCIM resource.
referenceTypes The names of the Resource Types never The attribute is never returned. This may occur
that may be referenced; e.g., User. because the original attribute value is not retained by
This is only applicable for attributes the service provider (e.g. such as with a hashed value).
that are of the "reference" data type. A service provider MAY allow attributes to be used in a
search filter.
canonicalValues A collection of canonical values. default The attribute is returned by default in all SCIM
When applicable Service Providers MUST operation responses where attribute values are returned.
specify the canonical types specified If the GET request "attributes" parameter is specified,
in the core schema specification; attribute values are only returned if the attribute is
e.g.,"work","home". OPTIONAL. named in the attributes parameter. DEFAULT.
request The attribute is returned in response to any PUT,
POST, or PATCH operations if the attribute was specified
by the client (for example, the attribute was modified).
The attribute is returned in a SCIM query operation only
if specified in the "attributes" parameter.
uniqueness A single keyword value that specifies how the
service provider enforces uniqueness of attribute values. A
server MAY reject an invalid value based on uniqueness by
returning HTTP Response code 400 (Bad Request). A client
MAY enforce uniqueness on the client-side to a greater
degree than the service provider enforces. For example, a
client could make a value unique while the server has
uniqueness of "none". Valid keywords are:
none The values are not intended to be unique in any way.
DEFAULT.
server The value SHOULD be unique within the context of the
current SCIM endpoint (or tenancy) but MAY not be
globally unique (e.g. a "username", email address, or
other server generated key or counter). No two resources
on the same server SHOULD possess the same value.
global The value SHOULD be globally unique (e.g. an email
address, a GUID, or other value). No two resources on
any server SHOULD possess the same value.
12. JSON Representation 12. JSON Representation
12.1. Minimal User Representation 12.1. Minimal User Representation
The following is a non-normative example of the minimal required SCIM The following is a non-normative example of the minimal required SCIM
representation in JSON format. representation in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:User"], "schemas": ["urn:scim:schemas:core:2.0:User"],
"id": "2819c223-7f76-453a-919d-413861904646", "id": "2819c223-7f76-453a-919d-413861904646",
"userName": "bjensen@example.com" "userName": "bjensen@example.com",
"meta": { "meta": {
"resourceType": "User", "resourceType": "User",
"created": "2010-01-23T04:56:22Z", "created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z", "lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff590\"", "version": "W\/\"3694e05e9dff590\"",
"location": "https://example.com/v1/Users/2819c223-7f76-453a-919d-413861904646" "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"
} }
} }
12.2. Full User Representation 12.2. Full User Representation
The following is a non-normative example of the fully populated SCIM The following is a non-normative example of the fully populated SCIM
representation in JSON format. representation in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:User"], "schemas": ["urn:scim:schemas:core:2.0:User"],
"id": "2819c223-7f76-453a-919d-413861904646", "id": "2819c223-7f76-453a-919d-413861904646",
"externalId": "701984", "externalId": "701984",
"userName": "bjensen@example.com", "userName": "bjensen@example.com",
"name": { "name": {
"formatted": "Ms. Barbara J Jensen III", "formatted": "Ms. Barbara J Jensen III",
"familyName": "Jensen", "familyName": "Jensen",
"givenName": "Barbara", "givenName": "Barbara",
"middleName": "Jane", "middleName": "Jane",
"honorificPrefix": "Ms.", "honorificPrefix": "Ms.",
"honorificSuffix": "III" "honorificSuffix": "III"
}, },
"displayName": "Babs Jensen", "displayName": "Babs Jensen",
"nickName": "Babs", "nickName": "Babs",
"profileUrl": "https://login.example.com/bjensen", "profileUrl": "https://login.example.com/bjensen",
"emails": [ "emails": [
{ {
"value": "bjensen@example.com", "value": "bjensen@example.com",
"type": "work", "type": "work",
"primary": true "primary": true
}, },
{ {
"value": "babs@jensen.org", "value": "babs@jensen.org",
"type": "home" "type": "home"
} }
], ],
"addresses": [ "addresses": [
{ {
"type": "work", "type": "work",
"streetAddress": "100 Universal City Plaza", "streetAddress": "100 Universal City Plaza",
"locality": "Hollywood", "locality": "Hollywood",
"region": "CA", "region": "CA",
"postalCode": "91608", "postalCode": "91608",
"country": "USA", "country": "USA",
"formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA", "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
"primary": true "primary": true
}, },
{ {
"type": "home", "type": "home",
"streetAddress": "456 Hollywood Blvd", "streetAddress": "456 Hollywood Blvd",
"locality": "Hollywood", "locality": "Hollywood",
"region": "CA", "region": "CA",
"postalCode": "91608", "postalCode": "91608",
"country": "USA", "country": "USA",
"formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA" "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA"
} }
], ],
"phoneNumbers": [ "phoneNumbers": [
{ {
"value": "555-555-5555", "value": "555-555-5555",
"type": "work" "type": "work"
}, },
{ {
"value": "555-555-4444", "value": "555-555-4444",
"type": "mobile" "type": "mobile"
} }
], ],
"ims": [ "ims": [
{ {
"value": "someaimhandle", "value": "someaimhandle",
"type": "aim" "type": "aim"
} }
], ],
"photos": [ "photos": [
{ {
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F", "value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo" "type": "photo"
}, },
{ {
"value": "https://photos.example.com/profilephoto/72930000000Ccne/T", "value": "https://photos.example.com/profilephoto/72930000000Ccne/T",
"type": "thumbnail" "type": "thumbnail"
} }
], ],
"userType": "Employee", "userType": "Employee",
"title": "Tour Guide", "title": "Tour Guide",
"preferredLanguage":"en_US", "preferredLanguage":"en_US",
"locale": "en_US", "locale": "en_US",
"timezone": "America/Los_Angeles", "timezone": "America/Los_Angeles",
"active":true, "active":true,
"password":"t1meMa$heen", "password":"t1meMa$heen",
"groups": [ "groups": [
{ {
"value": "e9e30dba-f08f-4109-8486-d5c6a331660a", "value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
"$ref": "https://example.com/v1/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a", "$ref": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
"display": "Tour Guides" "display": "Tour Guides"
}, },
{ {
"value": "fc348aa8-3835-40eb-a20b-c726e15c55b5", "value": "fc348aa8-3835-40eb-a20b-c726e15c55b5",
"$ref": "https://example.com/v1/Groups/fc348aa8-3835-40eb-a20b-c726e15c55b5", "$ref": "https://example.com/v2/Groups/fc348aa8-3835-40eb-a20b-c726e15c55b5",
"display": "Employees" "display": "Employees"
}, },
{ {
"value": "71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7", "value": "71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"$ref": "https://example.com/v1/Groups/71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7", "$ref": "https://example.com/v2/Groups/71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"display": "US Employees" "display": "US Employees"
} }
], ],
"x509Certificates": [ "x509Certificates": [
{ {
"value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMx "value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMx
EzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYD EzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYD
VQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFa VQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFa
MH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtl MH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtl
eGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIw eGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIw
IAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B IAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B
AQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc AQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc
1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5i 1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5i
PSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZ PSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZ
zidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3 zidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3
DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDr DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDr
SGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNV SGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNV
HRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZp HRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZp
Y2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAU Y2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAU
dGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJt dGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJt
Ng5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1R Ng5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1R
C4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1 C4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1
+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo=" +GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo="
} }
], ],
"meta": { "meta": {
"resourceType": "User", "resourceType": "User",
"created": "2010-01-23T04:56:22Z", "created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z", "lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"a330bc54f0671c9\"", "version": "W\/\"a330bc54f0671c9\"",
"location": "https://example.com/v1/Users/2819c223-7f76-453a-919d-413861904646" "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"
} }
} }
12.3. Enterprise User Extension Representation 12.3. Enterprise User Extension Representation
The following is a non-normative example of the fully populated User The following is a non-normative example of the fully populated User
using the enterprise User extension in JSON format. using the enterprise User extension in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:User", "urn:scim:schemas:extension:enterprise:2.0:User"], "schemas": ["urn:scim:schemas:core:2.0:User", "urn:scim:schemas:extension:enterprise:2.0:User"],
"id": "2819c223-7f76-453a-919d-413861904646", "id": "2819c223-7f76-453a-919d-413861904646",
"externalId": "701984", "externalId": "701984",
"userName": "bjensen@example.com", "userName": "bjensen@example.com",
"name": { "name": {
"formatted": "Ms. Barbara J Jensen III", "formatted": "Ms. Barbara J Jensen III",
"familyName": "Jensen", "familyName": "Jensen",
"givenName": "Barbara", "givenName": "Barbara",
"middleName": "Jane", "middleName": "Jane",
"honorificPrefix": "Ms.", "honorificPrefix": "Ms.",
"honorificSuffix": "III" "honorificSuffix": "III"
}, },
"displayName": "Babs Jensen", "displayName": "Babs Jensen",
"nickName": "Babs", "nickName": "Babs",
"profileUrl": "https://login.example.com/bjensen", "profileUrl": "https://login.example.com/bjensen",
"emails": [ "emails": [
{ {
"value": "bjensen@example.com", "value": "bjensen@example.com",
"type": "work", "type": "work",
"primary": true "primary": true
}, },
{ {
"value": "babs@jensen.org", "value": "babs@jensen.org",
"type": "home" "type": "home"
} }
],
"addresses": [ ],
{ "addresses": [
"streetAddress": "100 Universal City Plaza", {
"locality": "Hollywood", "streetAddress": "100 Universal City Plaza",
"region": "CA", "locality": "Hollywood",
"postalCode": "91608", "region": "CA",
"country": "USA", "postalCode": "91608",
"formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA", "country": "USA",
"type": "work", "formatted": "100 Universal City Plaza\nHollywood, CA 91608 USA",
"primary": true "type": "work",
}, "primary": true
{ },
"streetAddress": "456 Hollywood Blvd", {
"locality": "Hollywood", "streetAddress": "456 Hollywood Blvd",
"region": "CA", "locality": "Hollywood",
"postalCode": "91608", "region": "CA",
"country": "USA", "postalCode": "91608",
"formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA", "country": "USA",
"type": "home" "formatted": "456 Hollywood Blvd\nHollywood, CA 91608 USA",
} "type": "home"
],
"phoneNumbers": [
{
"value": "555-555-5555",
"type": "work"
},
{
"value": "555-555-4444",
"type": "mobile"
}
],
"ims": [
{
"value": "someaimhandle",
"type": "aim"
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo"
},
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/T",
"type": "thumbnail"
}
],
"userType": "Employee",
"title": "Tour Guide",
"preferredLanguage":"en_US",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"active":true,
"password":"t1meMa$heen",
"groups": [
{
"value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
"$ref": "/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
"display": "Tour Guides"
},
{
"value": "fc348aa8-3835-40eb-a20b-c726e15c55b5",
"$ref": "/Groups/fc348aa8-3835-40eb-a20b-c726e15c55b5",
"display": "Employees"
},
{
"value": "71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"$ref": "/Groups/71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"display": "US Employees"
}
],
"x509Certificates": [
{
"value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMx
EzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYD
VQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFa
MH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtl
eGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIw
IAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B
AQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc
1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5i
PSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZ
zidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3
DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDr
SGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNV
HRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZp
Y2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAU
dGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJt
Ng5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1R
C4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1
+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo="
}
],
"urn:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "701984",
"costCenter": "4130",
"organization": "Universal Studios",
"division": "Theme Park",
"department": "Tour Operations",
"manager": {
"managerId": "26118915-6090-4610-87e4-49d8ca9f808d",
"$ref": "/Users/26118915-6090-4610-87e4-49d8ca9f808d",
"displayName": "John Smith"
}
},
"meta": {
"resourceType": "User",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff591\"",
"location": "https://example.com/v1/Users/2819c223-7f76-453a-919d-413861904646"
} }
} ],
"phoneNumbers": [
{
"value": "555-555-5555",
"type": "work"
},
{
"value": "555-555-4444",
"type": "mobile"
}
],
"ims": [
{
"value": "someaimhandle",
"type": "aim"
}
],
"photos": [
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/F",
"type": "photo"
},
{
"value": "https://photos.example.com/profilephoto/72930000000Ccne/T",
"type": "thumbnail"
}
],
"userType": "Employee",
"title": "Tour Guide",
"preferredLanguage":"en_US",
"locale": "en_US",
"timezone": "America/Los_Angeles",
"active":true,
"password":"t1meMa$heen",
"groups": [
{
"value": "e9e30dba-f08f-4109-8486-d5c6a331660a",
"$ref": "/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a",
"display": "Tour Guides"
},
{
"value": "fc348aa8-3835-40eb-a20b-c726e15c55b5",
"$ref": "/Groups/fc348aa8-3835-40eb-a20b-c726e15c55b5",
"display": "Employees"
},
{
"value": "71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"$ref": "/Groups/71ddacd2-a8e7-49b8-a5db-ae50d0a5bfd7",
"display": "US Employees"
}
],
"x509Certificates": [
{
"value": "MIIDQzCCAqygAwIBAgICEAAwDQYJKoZIhvcNAQEFBQAwTjELMAkGA1UEBhMCVVMx
EzARBgNVBAgMCkNhbGlmb3JuaWExFDASBgNVBAoMC2V4YW1wbGUuY29tMRQwEgYD
VQQDDAtleGFtcGxlLmNvbTAeFw0xMTEwMjIwNjI0MzFaFw0xMjEwMDQwNjI0MzFa
MH8xCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMRQwEgYDVQQKDAtl
eGFtcGxlLmNvbTEhMB8GA1UEAwwYTXMuIEJhcmJhcmEgSiBKZW5zZW4gSUlJMSIw
IAYJKoZIhvcNAQkBFhNiamVuc2VuQGV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0B
AQEFAAOCAQ8AMIIBCgKCAQEA7Kr+Dcds/JQ5GwejJFcBIP682X3xpjis56AK02bc
1FLgzdLI8auoR+cC9/Vrh5t66HkQIOdA4unHh0AaZ4xL5PhVbXIPMB5vAPKpzz5i
PSi8xO8SL7I7SDhcBVJhqVqr3HgllEG6UClDdHO7nkLuwXq8HcISKkbT5WFTVfFZ
zidPl8HZ7DhXkZIRtJwBweq4bvm3hM1Os7UQH05ZS6cVDgweKNwdLLrT51ikSQG3
DYrl+ft781UQRIqxgwqCfXEuDiinPh0kkvIi5jivVu1Z9QiwlYEdRbLJ4zJQBmDr
SGTMYn4lRc2HgHO4DqB/bnMVorHB0CC6AV1QoFK4GPe1LwIDAQABo3sweTAJBgNV
HRMEAjAAMCwGCWCGSAGG+EIBDQQfFh1PcGVuU1NMIEdlbmVyYXRlZCBDZXJ0aWZp
Y2F0ZTAdBgNVHQ4EFgQU8pD0U0vsZIsaA16lL8En8bx0F/gwHwYDVR0jBBgwFoAU
dGeKitcaF7gnzsNwDx708kqaVt0wDQYJKoZIhvcNAQEFBQADgYEAA81SsFnOdYJt
Ng5Tcq+/ByEDrBgnusx0jloUhByPMEVkoMZ3J7j1ZgI8rAbOkNngX8+pKfTiDz1R
C4+dx8oU6Za+4NJXUjlL5CvV6BEYb1+QAEJwitTVvxB/A67g42/vzgAtoRUeDov1
+GFiBZ+GNF/cAYKcMtGcrs2i97ZkJMo="
}
],
"urn:scim:schemas:extension:enterprise:2.0:User": {
"employeeNumber": "701984",
"costCenter": "4130",
"organization": "Universal Studios",
"division": "Theme Park",
"department": "Tour Operations",
"manager": {
"managerId": "26118915-6090-4610-87e4-49d8ca9f808d",
"$ref": "/Users/26118915-6090-4610-87e4-49d8ca9f808d",
"displayName": "John Smith"
}
},
"meta": {
"resourceType": "User",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff591\"",
"location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646"
}
}
12.4. Group Representation 12.4. Group Representation
The following is a non-normative example of SCIM Group representation The following is a non-normative example of SCIM Group representation
in JSON format. in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:Group"], "schemas": ["urn:scim:schemas:core:2.0:Group"],
"id": "e9e30dba-f08f-4109-8486-d5c6a331660a", "id": "e9e30dba-f08f-4109-8486-d5c6a331660a",
"displayName": "Tour Guides", "displayName": "Tour Guides",
"members": [ "members": [
{ {
"value": "2819c223-7f76-453a-919d-413861904646", "value": "2819c223-7f76-453a-919d-413861904646",
"$ref": "https://example.com/v1/Users/2819c223-7f76-453a-919d-413861904646", "$ref": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
"display": "Babs Jensen" "display": "Babs Jensen"
}, },
{ {
"value": "902c246b-6245-4190-8e05-00816be7344a", "value": "902c246b-6245-4190-8e05-00816be7344a",
"$ref": "https://example.com/v1/Users/902c246b-6245-4190-8e05-00816be7344a", "$ref": "https://example.com/v2/Users/902c246b-6245-4190-8e05-00816be7344a",
"display": "Mandy Pepperidge" "display": "Mandy Pepperidge"
} }
] ],
"meta": { "meta": {
"resourceType": "Group", "resourceType": "Group",
"created": "2010-01-23T04:56:22Z", "created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z", "lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff592\"", "version": "W\/\"3694e05e9dff592\"",
"location": "https://example.com/v1/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a" "location": "https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a"
} }
} }
12.5. Service Provider Configuration Representation 12.5. Service Provider Configuration Representation
The following is a non-normative example of the SCIM Service Provider The following is a non-normative example of the SCIM service provider
Configuration representation in JSON format. configuration representation in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:ServiceProviderConfig"], "schemas": ["urn:scim:schemas:core:2.0:ServiceProviderConfig"],
"documentationUrl":"http://example.com/help/scim.html", "documentationUrl":"http://example.com/help/scim.html",
"patch": { "patch": {
"supported":true "supported":true
}, },
"bulk": { "bulk": {
"supported":true, "supported":true,
"maxOperations":1000, "maxOperations":1000,
"maxPayloadSize":1048576 "maxPayloadSize":1048576
}, },
"filter": { "filter": {
"supported":true, "supported":true,
"maxResults": 200 "maxResults": 200
}, },
"changePassword" : { "changePassword" : {
"supported":true "supported":true
}, },
"sort": { "sort": {
"supported":true "supported":true
}, },
"etag": { "etag": {
"supported":true "supported":true
}, },
"authenticationSchemes": [ "authenticationSchemes": [
{ {
"name": "OAuth Bearer Token", "name": "OAuth Bearer Token",
"description": "Authentication Scheme using the OAuth Bearer Token Standard", "description": "Authentication Scheme using the OAuth Bearer Token Standard",
"specUrl":"http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01", "specUrl":"http://tools.ietf.org/html/draft-ietf-oauth-v2-bearer-01",
"documentationUrl":"http://example.com/help/oauth.html", "documentationUrl":"http://example.com/help/oauth.html",
"type":"oauthbearertoken", "type":"oauthbearertoken",
"primary": true "primary": true
}, },
{ {
"name": "HTTP Basic", "name": "HTTP Basic",
"description": "Authentication Scheme using the Http Basic Standard", "description": "Authentication Scheme using the Http Basic Standard",
"specUrl":"http://www.ietf.org/rfc/rfc2617.txt", "specUrl":"http://www.ietf.org/rfc/rfc2617.txt",
"documentationUrl":"http://example.com/help/httpBasic.html", "documentationUrl":"http://example.com/help/httpBasic.html",
"type":"httpbasic" "type":"httpbasic"
}
],
"meta": {
"resourceType": "ServiceProviderConfig"
"created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff594\""
} }
} ],
"meta": {
"location":"https://example.com/v2/ServiceProviderConfig",
"resourceType": "ServiceProviderConfig",
"created": "2010-01-23T04:56:22Z",
"lastModified": "2011-05-13T04:42:34Z",
"version": "W\/\"3694e05e9dff594\""
}
}
12.6. Resource Type Representation 12.6. Resource Type Representation
The following is a normative example of the SCIM Resource Type The following is a non-normative example of the SCIM resource type
representation in JSON format. representation in JSON format.
{ {
"schemas": ["urn:scim:schemas:core:2.0:ResourceType"], "schemas": ["urn:scim:schemas:core:2.0:ResourceType"],
"name": "User", "id":"User",
"endpoint": "/Users", "name":"User",
"description": "Core User", "endpoint": "/Users",
"schema": "urn:scim:schemas:core:2.0:User", "description": "Core User",
"schemaExtensions": [ "schema": "urn:scim:schemas:core:2.0:User",
{ "schemaExtensions": [
"schema": "urn:scim:schemas:extension:enterprise:2.0:EnterpriseUser", {
"required": true "schema": "urn:scim:schemas:extension:enterprise:2.0:EnterpriseUser",
} "required": true
], }
"meta": { ],
"resourceType": "ResourceType", "meta": {
"created": "2010-01-23T04:56:22Z", "location":"https://example.com/v2/ResourceTypes/User",
"lastModified": "2011-05-13T04:42:34Z", "resourceType": "ResourceType",
"version": "W\/\"3694e05e9dff595\"" "created": "2010-01-23T04:56:22Z",
} "lastModified": "2011-05-13T04:42:34Z",
} "version": "W\/\"3694e05e9dff595\""
}
}
12.7. Schema Representation 12.7. Schema Representation
The following is a normative example of the SCIM Schema The following is intended as normative example of the SCIM Schema
representation in JSON format. representation in JSON format. Where permitted individual values and
schema MAY change. Included but not limited to, are schemas for
{ User, Group, and enterprise user.
"id": "urn:scim:schemas:core:2.0:User",
"name": "User",
"description": "Core User",
"attributes":[
{
"name":"id",
"type":"string",
"multiValued":false,
"description":"Unique identifier for the SCIM resource as defined by the Service Provider. Each representation of the resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of resources. It MUST be a stable, non-reassignable identifier that does not change when the same resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. REQUIRED.",
"readOnly":true,
"required":true,
"caseExact":false
},
{
"name":"name",
"type":"complex",
"multiValued":false,
"description":"The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.",
"readOnly":false,
"required":false,
"caseExact":false,
"subAttributes":[
{
"name":"formatted",
"type":"string",
"multiValued":false,
"description":"The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g. Ms. Barbara J Jensen, III.)." ,
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"familyName",
"type":"string",
"multiValued":false,
"description":"The family name of the User, or Last Name in most Western languages (e.g. Jensen given the full name Ms. Barbara J Jensen, III.).",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"givenName",
"type":"string",
"multiValued":false,
"description":"The given name of the User, or First Name in most Western languages (e.g. Barbara given the full name Ms. Barbara J Jensen, III.).",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"middleName",
"type":"string",
"multiValued":false,
"description":"The middle name(s) of the User (e.g. Robert given the full name Ms. Barbara J Jensen, III.).",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"honorificPrefix",
"type":"string",
"multiValued":false,
"description":"The honorific prefix(es) of the User, or Title in most Western languages (e.g. Ms. given the full name Ms. Barbara J Jensen, III.).",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"honorificSuffix",
"type":"string",
"multiValued":false,
"description":"The honorific suffix(es) of the User, or Suffix in most Western languages (e.g. III. given the full name Ms. Barbara J Jensen, III.).",
"readOnly":false,
"required":false,
"caseExact":false
}
]
},
{
"name":"emails",
"type":"complex",
"multiValued":true,
"description":"E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g. bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.",
"readOnly":false,
"required":false,
"caseExact":false,
"subAttributes":[
{
"name":"value",
"type":"string",
"multiValued":false,
"description":"E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g. bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"display",
"type":"string",
"multiValued":false,
"description":"A human readable name, primarily used for display purposes. READ-ONLY.",
"readOnly":true,
"required":false,
"caseExact":false
},
{
"name":"type",
"type":"string",
"multiValued":false,
"description":"A label indicating the attribute's function; e.g., 'work' or 'home'.",
"readOnly":false,
"required":false,
"caseExact":false,
"canonicalValues":["work","home","other"]
},
{
"name":"primary",
"type":"boolean",
"multiValued":false,
"description":"A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred mailing address or primary e-mail address. The primary attribute value 'true' MUST appear no more than once.",
"readOnly":false,
"required":false,
"caseExact":false
}
},
{
"name":"addresses",
"type":"complex",
"multiValued":true,
"description":"A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.",
"readOnly":false,
"required":false,
"caseExact":false,
"subAttributes":[
{
"name":"formatted",
"type":"string",
"multiValued":false,
"description":"The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"streetAddress",
"type":"string",
"multiValued":false,
"description":"The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"locality",
"type":"string",
"multiValued":false,
"description":"The city or locality component.",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"region",
"type":"string",
"multiValued":false,
"description":"The state or region component.",
"readOnly":false,
"required":false,
"caseExact":false
},
{
"name":"postalCode",
"type":"string",
"multiValued":false,
"description":"The zipcode or postal code component.",
"readOnly":false,
"required":false,
"caseExact":false
}, {[
{ {
"name":"country", "id" : "urn:scim:schemas:core:2.0:User",
"type":"string", "name" : "User",
"multiValued":false, "description" : "Core User",
"description":"The country name component.", "attributes" : [
"readOnly":false, {
"required":false, "name" : "id",
"caseExact":false "type" : "string",
}, "multiValued" : false,
{ "description" : "Unique identifier for the SCIM resource as defined by the Service Provider. Each representation of the resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of resources. It MUST be a stable, non-reassignable identifier that does not change when the same resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. REQUIRED.",
"name":"type", "required" : true,
"type":"string", "caseExact" : false,
"multiValued":false, "mutability" : "readOnly",
"description":"A label indicating the attribute's function; e.g., 'work' or 'home'.", "returned" : "always",
"readOnly":false, "uniqueness" : "server"
"required":false, },
"caseExact":false, {
"canonicalValues":["work","home","other"] "name" : "externalId",
} "type" : "string",
] "multiValued" : false,
} "description" : "An identifier for the Resource as defined by the Service Consumer.",
], "required" : true,
"meta": { "caseExact" : false,
"resourceType": "Schema" "mutability" : "readWrite",
"created": "2010-01-23T04:56:22Z", "returned" : "default",
"lastModified": "2011-05-13T04:42:34Z", "uniqueness" : "none"
"version": "W\/\"3694e05e9dff596\"", },
"location": "https://example.com/v1/Schemas/urn:scim:schemas:core:2.0:User" {
} "name" : "userName",
} "type" : "string",
"multiValued" : false,
"description" : "Unique identifier for the User typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the Service Consumer's entire set of Users. REQUIRED",
"required" : true,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "server"
},
{
"name" : "name",
"type" : "complex",
"multiValued" : false,
"description" : "The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both. If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "formatted",
"type" : "string",
"multiValued" : false,
"description" : "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g. Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "familyName",
"type" : "string",
"multiValued" : false,
"description" : "The family name of the User, or Last Name in most Western languages (e.g. Jensen given the full name Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "givenName",
"type" : "string",
"multiValued" : false,
"description" : "The given name of the User, or First Name in most Western languages (e.g. Barbara given the full name Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "middleName",
"type" : "string",
"multiValued" : false,
"description" : "The middle name(s) of the User (e.g. Robert given the full name Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "honorificPrefix",
"type" : "string",
"multiValued" : false,
"description" : "The honorific prefix(es) of the User, or Title in most Western languages (e.g. Ms. given the full name Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "honorificSuffix",
"type" : "string",
"multiValued" : false,
"description" : "The honorific suffix(es) of the User, or Suffix in most Western languages (e.g. III. given the full name Ms. Barbara J Jensen, III.).",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "displayName",
"type" : "string",
"multiValued" : false,
"description" : "The name of the User, suitable for display to end-users. The name SHOULD be the full name of the User being described if known",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "nickName",
"type" : "string",
"multiValued" : false,
"description" : "The casual way to address the user in real life, e.g. \"Bob\" or \"Bobby\" instead of \"Robert\". This attribute SHOULD NOT be used to represent a User's username (e.g. bjensen or mpepperidge)",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "profileUrl",
"type" : "string",
"multiValued" : false,
"description" : "A fully qualified URL to a page representing the User's online profile",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "title",
"type" : "string",
"multiValued" : false,
"description" : "The user's title, such as \"Vice President.\"",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "userType",
"type" : "string",
"multiValued" : false,
"description" : "Used to identify the organization to user relationship. Typical values used might be \"Contractor\", \"Employee\", \"Intern\", \"Temp\", \"External\", and \"Unknown\" but any value may be used ",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "preferredLanguage",
"type" : "string",
"multiValued" : false,
"description" : "Indicates the User's preferred written or spoken language. Generally used for selecting a localized User interface. e.g., 'en_US' specifies the language English and country US.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "locale",
"type" : "string",
"multiValued" : false,
"description" : "Used to indicate the User's default location for purposes of localizing items such as currency, date time format, numerical representations, etc.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "timezone",
"type" : "string",
"multiValued" : false,
"description" : "The User's time zone in the \"Olson\" timezone database format [19]; e.g.,'America/Los_Angeles'",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "active",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the User's administrative status.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "password",
"type" : "string",
"multiValued" : false,
"description" : "The User's clear text password. This attribute is intended to be used as a means to specify an initial password when creating a new User or to reset an existing User's password.",
"required" : false,
"caseExact" : false,
"mutability" : "writeOnly",
"returned" : "never",
"uniqueness" : "none"
},
{
"name" : "emails",
"type" : "complex",
"multiValued" : true,
"description" : "E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g. bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "E-mail addresses for the user. The value SHOULD be canonicalized by the Service Provider, e.g. bjensen@example.com instead of bjensen@EXAMPLE.COM. Canonical Type values of work, home, and other.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'work' or 'home'.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"work",
"home",
"other"
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred mailing address or primary e-mail address. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "phoneNumbers",
"type" : "complex",
"multiValued" : true,
"description" : "Phone numbers for the User. The value SHOULD be canonicalized by the Service Provider according to format in RFC3966 [20] e.g. 'tel:+1-201-555-0123'. Canonical Type values of work, home, mobile, fax, pager and other.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "Phone number of the User",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'work' or 'home' or 'mobile' etc.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"work",
"home",
"mobile",
"fax",
"pager",
"other"
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred phone number or primary phone number. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "ims",
"type" : "complex",
"multiValued" : true,
"description" : "Instant messaging addresses for the User.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "Instant messaging address for the User.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'aim', 'gtalk', 'mobile' etc.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"aim",
"gtalk",
"icq",
"xmpp",
"msn",
"skype",
"qq",
"yahoo"
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred messenger or primary messenger. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "photos",
"type" : "complex",
"multiValued" : true,
"description" : "URLs of photos of the User.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "URL of a photo of the User.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'photo' or 'thumbnail'.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"photo",
"thumbnail"
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred photo or thumbnail. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "addresses",
"type" : "complex",
"multiValued" : true,
"description" : "A physical mailing address for this User, as described in (address Element). Canonical Type Values of work, home, and other. The value attribute is a complex type with the following sub-attributes.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "formatted",
"type" : "string",
"multiValued" : false,
"description" : "The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "streetAddress",
"type" : "string",
"multiValued" : false,
"description" : "The full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. This attribute MAY contain newlines.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "locality",
"type" : "string",
"multiValued" : false,
"description" : "The city or locality component.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "region",
"type" : "string",
"multiValued" : false,
"description" : "The state or region component.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "postalCode",
"type" : "string",
"multiValued" : false,
"description" : "The zipcode or postal code component.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "country",
"type" : "string",
"multiValued" : false,
"description" : "The country name component.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'work' or 'home'.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"work",
"home",
"other"
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "groups",
"type" : "complex",
"multiValued" : true,
"description" : "A list of groups that the user belongs to, either thorough direct membership, nested groups, or dynamically calculated",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "The identifier of the User's group.",
"readOnly" : false,
"required" : false,
"caseExact" : false,
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "$ref",
"type" : "string",
"multiValued" : false,
"description" : "The URI of the corresponding Group resource to which the user belongs",
"readOnly" : false,
"required" : false,
"caseExact" : false,
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"readOnly" : true,
"required" : false,
"caseExact" : false,
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function; e.g., 'direct' or 'indirect'.",
"readOnly" : false,
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"direct",
"indirect"
],
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "entitlements",
"type" : "complex",
"multiValued" : true,
"description" : "A list of entitlements for the User that represent a thing the User has.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "The value of an entitlement.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "roles",
"type" : "complex",
"multiValued" : true,
"description" : "A list of roles for the User that collectively represent who the User is; e.g., 'Student', 'Faculty'.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "The value of a role.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "x509Certificates",
"type" : "complex",
"multiValued" : true,
"description" : "A list of certificates issued to the User.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "The value of a X509 certificate.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "display",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name, primarily used for display purposes. READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the attribute's function.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "primary",
"type" : "boolean",
"multiValued" : false,
"description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"meta" : {
"resourceType" : "Schema",
"created" : "2010-01-23T04:56:22Z",
"lastModified" : "2014-02-04T00:00:00Z",
"version" : "W/\"3694e05e9dff596\"",
"location" : "https://example.com/v2/Schemas/urn:scim:schemas:core:2.0:User"
}
},
{
"id" : "urn:scim:schemas:core:2.0:Group",
"name" : "Group",
"description" : "Core Group",
"attributes" : [
{
"name" : "id",
"type" : "string",
"multiValued" : false,
"description" : "Unique identifier for the SCIM resource as defined by the Service Provider. Each representation of the resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider's entire set of resources. It MUST be a stable, non-reassignable identifier that does not change when the same resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. REQUIRED.",
"required" : true,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "always",
"uniqueness" : "server"
},
{
"name" : "externalId",
"type" : "string",
"multiValued" : false,
"description" : "An identifier for the Resource as defined by the Service Consumer.",
"required" : true,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "displayName",
"type" : "string",
"multiValued" : false,
"description" : "A human readable name for the Group. REQUIRED.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "members",
"type" : "complex",
"multiValued" : false,
"description" : "A list of members of the Group.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "value",
"type" : "string",
"multiValued" : false,
"description" : "The identifier of the member of this Group.",
"required" : false,
"caseExact" : false,
"mutability" : "immutable",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "$ref",
"type" : "string",
"multiValued" : false,
"description" : "The URI of the corresponding to the member resource of this Group.",
"required" : false,
"caseExact" : false,
"mutability" : "immutable",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "type",
"type" : "string",
"multiValued" : false,
"description" : "A label indicating the type of resource; e.g., 'User' or 'Group'.",
"required" : false,
"caseExact" : false,
"canonicalValues" : [
"User",
"Group"
],
"mutability" : "immutable",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"meta" : {
"resourceType" : "Schema",
"created" : "2010-01-23T04:56:22Z",
"lastModified" : "2014-02-04T00:00:00Z",
"version" : "W/\"3694e05e9dff596\"",
"location" : "https://example.com/v2/Schemas/urn:scim:schemas:core:2.0:Group"
}
},
{
"id" : "urn:scim:schemas:extension:enterprise:2.0:User",
"name" : "EnterpriseUser",
"description" : "Enterprise User",
"attributes" : [
{
"name" : "employeeNumber",
"type" : "string",
"multiValued" : false,
"description" : "Numeric or alphanumeric identifier assigned to a person, typically based on order of hire or association with an organization.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "costCenter",
"type" : "string",
"multiValued" : false,
"description" : "Identifies the name of a cost center.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "organization",
"type" : "string",
"multiValued" : false,
"description" : "Identifies the name of an organization.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "division",
"type" : "string",
"multiValued" : false,
"description" : "Identifies the name of a division.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "department",
"type" : "string",
"multiValued" : false,
"description" : "Identifies the name of a department.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "manager",
"type" : "complex",
"multiValued" : false,
"description" : "The User's manager. A complex type that optionally allows Service Providers to represent organizational hierarchy by referencing the \"id\" attribute of another User.",
"required" : false,
"caseExact" : false,
"subAttributes" : [
{
"name" : "managerId",
"type" : "string",
"multiValued" : false,
"description" : "The id of the SCIM resource representing the User's manager. REQUIRED.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "$ref",
"type" : "string",
"multiValued" : false,
"description" : "The URI of the SCIM resource representing the User's manager. REQUIRED.",
"required" : false,
"caseExact" : false,
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
},
{
"name" : "displayName",
"type" : "string",
"multiValued" : false,
"description" : "The displayName of the User's manager. OPTIONAL and READ-ONLY.",
"required" : false,
"caseExact" : false,
"mutability" : "readOnly",
"returned" : "default",
"uniqueness" : "none"
}
],
"mutability" : "readWrite",
"returned" : "default",
"uniqueness" : "none"
}
],
"meta" : {
"resourceType" : "Schema",
"created" : "2010-01-23T04:56:22Z",
"lastModified" : "2014-02-04T00:00:00Z",
"version" : "W/\"3694e05e9dff596\"",
"location" : "https://example.com/v2/Schemas/urn:scim:schemas:extension:enterprise:2.0:User"
}
}
]}
13. Security Considerations 13. Security Considerations
The SCIM Core schema contains personally identifiable information as The SCIM Core schema contains personally identifiable information as
well as other sensitive data. Aside from prohibiting password values well as other sensitive data. Aside from prohibiting password values
in a SCIM response this specification does not provide any means or in a SCIM response this specification does not provide any means or
guarantee of confidentiality. guarantee of confidentiality.
14. Normative References 14. References
14.1. Normative References
[ISO3166] "ISO 3166:1988 (E/F) - Codes for the representation of
names of countries - The International Organization for
Standardization, 3rd edition", 08 1988.
[ISO639-2]
ISO 639.2 Registration Authority, "ISO639-2: Codes for the
Representation of Names of Languages", July 2013.
[Olson-TZ]
"Sources for Time Zone and Daylight Saving Time Data", .
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3966] Schulzrinne, H., "The tel URI for Telephone Numbers", RFC
3966, December 2004.
[RFC3986] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66, RFC
3986, January 2005.
[RFC4627] Crockford, D., "The application/json Media Type for
JavaScript Object Notation (JSON)", RFC 4627, July 2006.
[XML-Schema]
Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes
Second Edition", October 2004.
14.2. Informative References
[PortableContacts] [PortableContacts]
Smarr, J., "Portable Contacts 1.0 Draft C - Schema Only", Smarr, J., "Portable Contacts 1.0 Draft C - Schema Only",
August 2008. August 2008.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC4512] Zeilenga, K., "Lightweight Directory Access Protocol
Requirement Levels", BCP 14, RFC 2119, March 1997. (LDAP): Directory Information Models", RFC 4512, June
2006.
Appendix A. Contributors Appendix A. Acknowledgements
The editors would like to acknowledge the contribution and work of
the past draft editors:
Chuck Mortimore, Salesforce
Patrick Harding, Ping
Paul Madsen, Ping
Trey Drake, UnboundID
The SCIM Community would like to thank the following people for the The SCIM Community would like to thank the following people for the
work they've done in the research, formulation, drafting, editing, work they've done in the research, formulation, drafting, editing,
and support of this specification. and support of this specification.
Morteza Ansari (morteza.ansari@cisco.com) Morteza Ansari (morteza.ansari@cisco.com)
Sidharth Choudhury (schoudhury@salesforce.com) Sidharth Choudhury (schoudhury@salesforce.com)
Samuel Erdtman (samuel@erdtman.se) Samuel Erdtman (samuel@erdtman.se)
Kelly Grizzle (kelly.grizzle@sailpoint.com) Kelly Grizzle (kelly.grizzle@sailpoint.com)
Chris Phillips (cjphillips@gmail.com) Chris Phillips (cjphillips@gmail.com)
Erik Wahlstroem (erik.wahlstrom@nexussafe.com) Erik Wahlstroem (erik.wahlstrom@nexussafe.com)
Phil Hunt (phil.hunt@yahoo.com)
Special thanks to Joeseph Smarr, who's excellent work on the Portable Special thanks to Joeseph Smarr, who's excellent work on the Portable
Contacts Specification [PortableContacts] provided a basis for the Contacts Specification [PortableContacts] provided a basis for the
SCIM schema structure and text. SCIM schema structure and text.
Appendix B. Change Log
[[This section to be removed prior to publication as an RFC]]
Draft 02 - KG - Addition of schema extensibility
Draft 03 - PH - Revisions based on following tickets:
09 - Attribute uniquenes
10 - Returnability of attributes
35 - Attribute mutability (replaces readOnly)
52 - Minor textual changes
53 - Standard use of term client (some was consumer)
56 - Make manager attribute consistent with other $ref attrs
58 - Add optional id to ResourceType objects for consistency
59 - Fix capitalization per IETF editor practices
60 - Changed <eref> tags to normal <xref> and <reference> tags
Authors' Addresses Authors' Addresses
Chuck Mortimore (editor) Kelly Grizzle
Salesforce.com SailPoint
Email: cmortimore@salesforce.com Email: kelly.grizzle@sailpoint.com
Phil Hunt (editor)
Oracle Corporation
Patrick Harding Email: phil.hunt@yahoo.com
Ping Identity
Email: pharding@pingidentity.com Erik Wahlstroem
Technology Nexus
Paul Madsen Email: erik.wahlstrom@nexussafe.com
Ping Identity
Email: pmadsen@pingidentity.com Chuck Mortimore
Trey Drake Salesforce.com
UnboundID
Email: trey.drake@unboundid.com Email: cmortimore@salesforce.com
 End of changes. 184 change blocks. 
1000 lines changed or deleted 2050 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/