SCIMMY: Class - SCIMMY.Schemas.User

Class: SCIMMY .Schemas.User

SCIM User Schema

Summary:

Ensures a User instance conforms to the User schema set out in RFC7643§4.1.

Usage

Instantiates a new user that conforms to the SCIM User schema definition

                    
                        new SCIMMY.Schemas.User(resource, directionopt, basepathopt, filtersopt)

Extends:: SCIMMY.Types.Schema
Source:: src/lib/schemas/user.js, line 9

Parameters:

Name	Type	Default	Description
`resource`	`Object`		the source data to feed through the schema definition
`directionopt`	`String`	`"both"`	whether the resource is inbound from a request or outbound for a response
`basepathopt`	`String`		the base path for resolution of a resource's location
`filtersopt`	`SCIMMY.Types.Filter`		attribute filters to apply to the coerced value

Properties:

Name Type Description


                        userName


    String

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


                        nameopt


    Object

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

Properties

Name	Type	Description
`formattedopt`	`String`	the full name, including all middle names, titles, and suffixes as appropriate, formatted for display (e.g. 'Ms. Barbara J Jensen, III')
`familyNameopt`	`String`	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')
`givenNameopt`	`String`	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')
`middleNameopt`	`String`	the middle name(s) of the User (e.g. 'Jane' given the full name 'Ms. Barbara J Jensen, III')
`honorificPrefixopt`	`String`	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')
`honorificSuffixopt`	`String`	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')


                        displayNameopt


    String

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


                        nickNameopt


    String

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')


                        profileUrlopt


    String

a fully qualified URL pointing to a page representing the User's online profile


                        titleopt


    String

the user's title, such as 'Vice President'


                        userTypeopt


    String

used to identify the relationship between the organization and the user. Typical values used might be 'Contractor', 'Employee', 'Intern', 'Temp', 'External', and 'Unknown', but any value may be used


                        preferredLanguageopt


    String

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


                        localeopt


    String

used to indicate the User's default location for purposes of localizing items such as currency, date time format, or numerical representations


                        timezoneopt


    String

the User's time zone in the 'Olson' time zone database format, e.g. 'America/Los_Angeles'


                        activeopt


    Boolean

a Boolean value indicating the User's administrative status


                        passwordopt


    String

the User's cleartext 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


                        emailsopt


    Object[]

email 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'

Properties

Name	Type	Description
`value`	`String`	email 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'
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function, e.g. 'work' or 'home'
`primaryopt`	`Boolean`	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


                        phoneNumbersopt


    Object[]

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 'work', 'home', 'mobile', 'fax', 'pager', and 'other'

Properties

Name	Type	Description
`value`	`String`	phone number of the User
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function, e.g. 'work', 'home', 'mobile'
`primaryopt`	`Boolean`	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


                        imsopt


    Object[]

instant messaging addresses for the User

Properties

Name	Type	Description
`value`	`String`	instant messaging address for the User
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function, e.g. 'aim', 'gtalk', 'xmpp'
`primaryopt`	`Boolean`	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


                        photosopt


    Object[]

uRLs of photos of the User

Properties

Name	Type	Description
`value`	`String`	uRL of a photo of the User
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function, i.e., 'photo' or 'thumbnail'
`primaryopt`	`Boolean`	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


                        addressesopt


    Object[]

a physical mailing address for this User. Canonical type values of 'work', 'home', and 'other'

Properties

Name	Type	Description
`formattedopt`	`String`	the full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines
`streetAddressopt`	`String`	the full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information
`localityopt`	`String`	the city or locality component
`regionopt`	`String`	the state or region component
`postalCodeopt`	`String`	the zip code or postal code component
`countryopt`	`String`	the country name component
`typeopt`	`String`	a label indicating the attribute's function, e.g. 'work' or 'home'
`primaryopt`	`Boolean`	a Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g. the preferred mailing address or primary email address


                        groupsopt


    Object[]

a list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated

Properties

Name	Type	Description
`value`	`String`	the identifier of the User's group
`$refopt`	`String`	the URI of the corresponding 'Group' resource to which the user belongs
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function, e.g. 'direct' or 'indirect'


                        entitlementsopt


    Object[]

a list of entitlements for the User that represent a thing the User has

Properties

Name	Type	Description
`value`	`String`	the value of an entitlement
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function
`primaryopt`	`Boolean`	a Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once


                        rolesopt


    Object[]

a list of roles for the User that collectively represent who the User is, e.g. 'Student', 'Faculty'

Properties

Name	Type	Description
`value`	`String`	the value of a role
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function
`primaryopt`	`Boolean`	a Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once


                        x509Certificatesopt


    Object[]

a list of certificates issued to the User

Properties

Name	Type	Description
`value`	`String`	the value of an X.509 certificate
`displayopt`	`String`	a human-readable name, primarily used for display purposes
`typeopt`	`String`	a label indicating the attribute's function
`primaryopt`	`Boolean`	a Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once

Members

(static) id: "urn:ietf:params:scim:schemas:core:2.0:User"

SCIM schema URN namespace

Type:: {"urn:ietf:params:scim:schemas:core:2.0:User"}
Extends:: SCIMMY.Types.Schema.id
Source:: src/lib/schemas/user.js, line 11

(static) definition: SCIMMY.Types.SchemaDefinition

Retrieves a schema's definition instance

Type:: {SCIMMY.Types.SchemaDefinition}
Implements:: SCIMMY.Types.Schema.definition
Source:: src/lib/schemas/user.js, line 16