Source:

Module: mod-users

Interface: /users

Attributes:

Property Name Property Type Property Description
username string A unique name belonging to a user. Typically used for login
id string A globally unique (UUID) identifier for the user
externalSystemId string A unique ID that corresponds to an external authority
barcode string The unique library barcode for this user
active boolean A flag to determine if the user’s account is effective and not expired. The tenant configuration can require the user to be active for login. Active is different from the loan patron block
type string The class of user like staff or patron; this is different from patronGroup; it can store shadow, system user and dcb types also
patronGroup string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
departments array A list of UUIDs corresponding to the departments the user belongs to, see /departments API
meta object Deprecated
proxyFor array Deprecated
personal object Personal information about the user
personal/pronouns string The user’s pronouns
personal/lastName string The user’s surname
personal/firstName string The user’s given name
personal/middleName string The user’s middle name (if any)
personal/preferredFirstName string The user’s preferred name
personal/email string The user’s email address
personal/phone string The user’s primary phone number
personal/mobilePhone string The user’s mobile phone number
personal/dateOfBirth string The user’s birth date
personal/addresses array Physical addresses associated with the user
personal/addresses/id string A unique id for this address
personal/addresses/countryId string The country code for this address
personal/addresses/addressLine1 string Address, Line 1
personal/addresses/addressLine2 string Address, Line 2
personal/addresses/city string City name
personal/addresses/region string Region
personal/addresses/postalCode string Postal Code
personal/addresses/addressTypeId string A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/
personal/addresses/primaryAddress boolean Is this the user’s primary address?
personal/preferredContactTypeId string Id of user’s preferred contact type like Email, Mail or Text Message, see /addresstypes API
personal/profilePictureLink string Link to the profile picture
enrollmentDate string The date in which the user joined the organization
expirationDate string The date for when the user becomes inactive
createdDate string Deprecated
updatedDate string Deprecated
metadata object Metadata about creation and changes to records, provided by the server (client should not provide)
metadata/createdDate string Date and time when the record was created
metadata/createdByUserId string ID of the user who created the record (when available)
metadata/createdByUsername string Username of the user who created the record (when available)
metadata/updatedDate string Date and time when the record was last updated
metadata/updatedByUserId string ID of the user who last updated the record (when available)
metadata/updatedByUsername string Username of the user who last updated the record (when available)
tags object List of simple tags that can be added to an object
tags/tagList array List of tags
customFields object Object that contains custom field
preferredEmailCommunication array Preferred email communication types