User Schema example:

Request

GET "https://<CONDECO-SCIM-Domain>/scim/api/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": "active",
            "type": "boolean",
            "multiValued": false,
            "description": "A Boolean value indicating the User's administrative status.",
            "required": false,
            "mutability": "readWrite",
            "returned": "default"
        },
        {
            "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": "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"
                }
            ]
        }
    ],
    "meta": {
        "resourceType": "Schema",
        "location": "https://<CONDECO-SCIM-Domain>/scim/api/V1/schemas/urn:ietf:params:scim:schemas:core:2.0:User"
    }
}

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
Condeco Support

Post Comment