Schemas
The following schemas are supported:
Each schema detail can be fetched with schema by Id (../Schemas/Id):
urn:ietf:params:scim:schemas:core:2.0:User
urn:ietf:params:scim:schemas:core:2.0:Group
urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig
urn:ietf:params:scim:schemas:core:2.0:ResourceType
User schema
User Schema example:
Request
GET "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:core:2.0:User"
Response
HTTP/1.1 200 OK
{
"id": "urn:ietf:params:scim:schemas:core:2.0:User",
"name": "User",
"description": "User Account",
"attributes": [
{
"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 provider'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 can return just the individual component attributes using the sub-attributes (i.e. familyName and givenName). REQUIRED",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"subAttributes": [
{
"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",
"required": true,
"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",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "middleName",
"type": "string",
"multiValued": false,
"description": "Identifies the middle name of a user.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
}
]
},
{
"name": "active",
"type": "boolean",
"multiValued": false,
"description": "A Boolean value indicating the User's administrative status.",
"required": false,
"mutability": "readWrite",
"returned": "default"
},
{
"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": "The user's/employee type, such as 'Contractor','Permanent'.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "emails",
"type": "complex",
"multiValued": true,
"description": "Email addresses for the user. Only email address with primary true will be entertained. REQUIRED.",
"required": true,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"subAttributes": [
{
"name": "type",
"type": "string",
"multiValued": false,
"required": false,
"caseExact": false,
"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 email address.The primary attribute value 'true' MUST appear no more than once.",
"required": true,
"mutability": "readWrite",
"returned": "always"
},
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "A valid email addresses for the user e.g., 'bjensen@example.com'",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"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 the format specified in RFC 3966, e.g., 'tel:+1-201-555-0123'. Canonical type values of 'mobile', 'cell', or 'cellular'.",
"required": false,
"mutability": "readWrite",
"returned": "default",
"subAttributes": [
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "A label indicating the attribute's function, e.g., 'mobile', 'cell', 'cellular'.",
"required": false,
"canonicalValues": [
"mobile",
"cell",
"cellular"
],
"caseExact": false,
"mutability": "readWrite",
"returned": "never",
"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,
"mutability": "readWrite",
"returned": "always"
},
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "A valid phone number of the user.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
}
]
},
{
"name": "preferredLanguage",
"type": "string",
"multiValued": false,
"description": "Specifies language for selecting localized interface, uses IETF language code.e.g., 'en_US' specifies the language English and country US.",
"required": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "addresses",
"type": "complex",
"multiValued": true,
"description": "A physical address for this user. Only type values of 'work' will be entertained. This attribute is a complex type with the following sub-attributes. All sub-attributes are OPTIONAL.",
"required": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"subAttributes": [
{
"name": "type",
"type": "string",
"multiValued": false,
"description": "A label indicating the attribute's function, e.g., 'work'.",
"required": false,
"canonicalValues": [
"work"
],
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "country",
"type": "string",
"multiValued": false,
"description": "The country name component. When specified, the value MUST be in ISO 3166-1 'alpha - 2' or 'alpha - 3' or Full English Name.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "locality",
"type": "string",
"multiValued": false,
"description": "The city or locality component of the given country. Country should be valid.",
"required": false,
"caseExact": false,
"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 physical address.The primary attribute value 'true' MUST appear no more than once.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "formatted",
"type": "string",
"multiValued": false,
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
}
]
},
{
"name": "externalId",
"type": "string",
"multiValued": false,
"description": "The externalId, defined by the client, is required to be unique ONLY within the resources associated with the associated Tenant.",
"required": true,
"caseExact": false,
"mutability": "readOnly",
"returned": "default",
"uniqueness": "server"
}
],
"meta": {
"resourceType": "Schema",
"location": "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:core:2.0:User"
}
}
User extension schema
User Extension Schema example:
Request
GET "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
Response
HTTP/1.1 200 OK
{
"id": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"name": "EnterpriseUser",
"description": "Enterprise User",
"attributes": [
{
"name": "department",
"type": "string",
"multiValued": false,
"description": "Identifies the name of a department.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "costCenter",
"type": "string",
"multiValued": false,
"description": "Identifies the name of a cost center.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "employeeId",
"type": "string",
"multiValued": false,
"description": "Identifies the Employee code for User.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "manager",
"type": "complex",
"multiValued": false,
"description": "Identifies the Manager of the user.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "Id of that manager.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"name": "$ref",
"type": "string",
"multiValued": false,
"description": "The URI corresponding to a SCIM resource that is a manager of this User.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "DisplayName of that manager.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
}
]
},
{
"name": "organization",
"type": "string",
"multiValued": false,
"description": "Identifies the name of company.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
}
],
"meta": {
"resourceType": "Schema",
"location": "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
}
}
User custom extension schema
User Custom Extension Schema example:
Request
GET "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User"
Response
HTTP/1.1 200 OK
{
"id": "urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User",
"name": "CustomEnterpriseUser",
"description": "Custom Enterprise User",
"attributes": [
{
"name": "group",
"type": "string",
"multiValued": false,
"description": "Identifies the name of a group (business unit).",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "floor",
"type": "string",
"multiValued": false,
"description": "Identifies the number of a floor.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "phoneExtension",
"type": "string",
"multiValued": false,
"description": "Identifies a shorter telephone number that you can assign to a User,.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "workMode",
"type": "string",
"multiValued": false,
"description": "Identifies if a User is in-office, in-hybrid,full-time remote or none.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "image",
"type": "string",
"multiValued": false,
"description": "Returns profilePhoto URL of a User.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none"
},
{
"name": "usageLocation",
"type": "string",
"multiValued": false,
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "custom",
"type": "complex",
"multiValued": true,
"description": "A list of custom attributes.",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "always",
"uniqueness": "none",
"subAttributes": [
{
"name": "key",
"type": "string",
"multiValued": false,
"description": "The name of custom attribute",
"required": true,
"mutability": "readWrite",
"returned": "always"
},
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "The value of custom attribute",
"required": true,
"mutability": "readWrite",
"returned": "always"
}
]
}
],
"meta": {
"resourceType": "Schema",
"location": "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:extension:customextensionname:2.0:User"
}
}
Group schema
Group Schema example:
Request
GET "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
Response
HTTP/1.1 200 OK
{
"id": "urn:ietf:params:scim:schemas:core:2.0:Group",
"name": "Group",
"description": "Schema for representing the group",
"attributes": [
{
"name": "displayName",
"type": "string",
"multiValued": false,
"description": "A human-readable name for the group.",
"required": true,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none"
},
{
"name": "members",
"type": "complex",
"multiValued": true,
"description": "A list of members of the group. Only supported member type : User",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "never",
"uniqueness": "none",
"subAttributes": [
{
"name": "value",
"type": "string",
"multiValued": false,
"description": "Identifier of the member of this Group.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
},
{
"name": "$ref",
"type": "reference",
"multiValued": false,
"description": "The URI corresponding to a SCIM resource that is a member of this Group.",
"required": false,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "none"
}
]
},
{
"name": "externalId",
"type": "string",
"multiValued": false,
"description": "The externalId, defined by the client, is required to be unique ONLY within the resources associated with the associated Tenant.",
"required": false,
"caseExact": false,
"mutability": "readOnly",
"returned": "default",
"uniqueness": "server"
}
],
"meta": {
"resourceType": "Schema",
"location": "https://<Eptura-SCIM-Domain>/scim/v1/schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
}
}