Inkling Users

An Inkling user is someone who is part of one or more Inkling organizations. This user may have access to both Inkling Habitat and the Inkling Library, or only the Inkling Library.

An Inkling user can be an employee, contractor, or third-party service provider of the company that maintains the Inkling organization. If an Inkling user profile contains an email address, the address must be valid, but it can use a domain different from the company’s email domain.

User Data Model

This table lists the required and optional user data elements Inkling uses to create user account data, along with each element’s logical data type and description.

The right-side column describes the following information:

Required: Indicates if the element is required or optional.
Unique: Indicates if the element’s value must be unique within the organization’s submitted user data. For example, all usernames and email addresses must be unique.
Immutable: Indicates if the element’s value is static and cannot be modiﬁed.
Internal: Indicates if the element’s value is an internal system value and not displayed to a user.

Data element and Type	Description	Required Unique Immutable Internal
User Id Unicode string	Primary key of a user. Note: This element is case sensitive.	Y Y Y Y
Username Unicode string	Name that a user enters to log into the system. Note: Cannot include any leading or trailing whitespace, or any whitespace within the name.	Y Y N N
Email address Email address, per RFC-5322 section 3.4	User’s email address. The email address domain can be different from your company’s email domain. Note: Required when users are Habitat users. Not required for end users.	See Note Y N N
Status boolean	Indicates if the user is active.	Y N N Y
Habitat user boolean	Indicates if the user is an active Habitat user	Y N N Y
First Name Unicode string	User’s first name	Y N N N
Last Name Unicode string	User’s last name	Y N N N
Timestamp Unix Epoch	A timestamp used to determine the order of uploading user data when that user’s data appears multiple times in the same or different CSV files.	N N N Y
Custom attributes Unicode string key and value pairs	Dictionary of custom attributes associated with a user. Necessary if you are using Inkling Distribution Rules functionality to distribute published content. For more information about distribution rules, see Inkling Authoring Guide > Configure and Administer Habitat > Configure distribution for Inkling library users.	N N N N

Example User Data Values

This table provides example user data values for the required and optional fields.

Data Element	Example Value
User Id	35fe2dda-9f26-51bd-3fe8-02578d126d0a
Username	alau
Email address	alau@example.com
Status	true
Habitat user	true
First Name	Allen
Last Name	Lau
Timestamp	000000000000011479956
Department	Engineering
Oﬀice	Palo Alto
Position	Sr Engineering Mgr
Province/State	CA
Region	US West
Supervisor	Brown, Jordan

Data Source Table

User administrators can enter user data using the Habitat interface, a CSV file, or SAML 2.0 SSO. This table lists differences in data element value sources by data input method.

Data element	People tab Create User UI	CSV Upload column name	SAML SSO source
User Id	Calculated by Inkling	UserId	Comes from NameID claim (strongly recommended), or any single-valued attribute in the AttributeStatement. We strongly recommend that you use NameID for this data element as we require it when issuing a SAML Single Logout (SLO) request.
Username	User input	Username	Comes from NameID claim or any single-valued attribute in the AttributeStatement. Customer to indicate a preference.
Email address	User input		Comes from any attribute in the AttributeStatement. Customer to indicate a preference.
Status	true	Status Value is 0 or 1	Hardcoded to true, meaning the user is set as an active user. Not configurable.
Habitat user	User input	HabitatUser Value is 0 or 1	Hardcoded to false, meaning the user is not set as an active Habitat user. Not configurable.
First Name	User input	FirstName	Comes from any attribute in the AttributeStatement. Customer to indicate a preference.
Last Name	User input	LastName	Comes from any attribute in the AttributeStatement. Customer to indicate a preference.
Timestamp	Hardcoded to the current date and time	Timestamp	Hardcoded to the current date and time
Custom attributes	User input	custom attribute name	All single-valued attributes sent through the Attribute Statement assertion. Multi-valued SAML attributes are not supported.