{
  "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 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,
      "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":"reference",
      "referenceTypes":[
        "external"
      ],
      "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; 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,
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "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,
      "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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "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 e.g. 'tel:+1-201-555-0123'.  Canonical Type values of work, home, mobile, fax, pager and other.",
      "required":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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "name":"ims",
      "type":"complex",
      "multiValued":true,
      "description":"Instant messaging addresses for the User.",
      "required":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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "name":"photos",
      "type":"complex",
      "multiValued":true,
      "description":"URLs of photos of the User.",
      "required":false,
      "subAttributes":[
        {
          "name":"value",
          "type":"reference",
          "referenceTypes":[
            "external"
          ],
          "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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "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,
      "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,
      "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":"reference",
          "referenceTypes":[
            "User",
            "Group"
          ],
          "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"
    },
    {
      "name":"entitlements",
      "type":"complex",
      "multiValued":true,
      "description":"A list of entitlements for the User that represent a thing the User has.",
      "required":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,
          "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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "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,
      "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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    },
    {
      "name":"x509Certificates",
      "type":"complex",
      "multiValued":true,
      "description":"A list of certificates issued to the User.",
      "required":false,
      "caseExact":false,
      "subAttributes":[
        {
          "name":"value",
          "type":"binary",
          "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,
          "mutability":"readWrite",
          "returned":"default"
        }
      ],
      "mutability":"readWrite",
      "returned":"default"
    }
  ],
  "meta":{
    "resourceType":"Schema",
    "location":"/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
  }
}