user

User Search

Changed on

Search users

get/user

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/user
  • Auth
    none declared

Query parameters

userIdinteger

Filter by User Id

userNamestring

Filter by User Name

userTypeIdinteger

Filter by UserType Id

retiredinteger

Filter by Retired

sortBy'userId' | 'userName' | 'firstName' | 'lastName' | 'email' | 'homeFolder' | 'libraryQuotaFormatted' | 'lastAccessed' | 'retired' | 'twoFactorDescription' | 'phone' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

userIdinteger

The ID of this User

userNamestring

The user name

userTypeIdinteger

The user type ID

loggedIninteger

Flag indicating whether this user is logged in or not

emailstring

Email address of the user used for email alerts

homePageIdinteger

The pageId of the Homepage for this User

homeFolderIdinteger

This users home folder

lastAccessedinteger

A timestamp indicating the time the user last logged into the CMS

newUserWizardinteger

A flag indicating whether this user has see the new user wizard

retiredinteger

A flag indicating whether the user is retired

isPasswordChangeRequiredinteger

A flag indicating whether password change should be forced for this user

groupIdinteger

The users user group ID

groupinteger

The users group name

libraryQuotainteger

The users library quota in bytes

firstNamestring

First Name

lastNamestring

Last Name

phonestring

Phone Number

ref1string

Reference field 1

ref2string

Reference field 2

ref3string

Reference field 3

ref4string

Reference field 4

ref5string

Reference field 5

playlistsunknown
isSystemNotificationinteger

Does this User receive system notifications.

isDisplayNotificationinteger

Does this User receive system notifications.

isDataSetNotificationinteger

Does this User receive DataSet notifications.

isLayoutNotificationinteger

Does this User receive Layout notifications.

isLibraryNotificationinteger

Does this User receive Library notifications.

isReportNotificationinteger

Does this User receive Report notifications.

isScheduleNotificationinteger

Does this User receive Schedule notifications.

isCustomNotificationinteger

Does this User receive Custom notifications.

twoFactorTypeIdinteger

The two factor type id

twoFactorSecretstring

Two Factor authorisation shared secret for this user

twoFactorRecoveryCodesstring[]

Two Factor authorisation recovery codes

Changes

  • 622fb073aecdRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

  • 9136e3c2cb1dRevision changes
    • breaking

      removed the enum value libraryQuota from the query request parameter sortBy

    • breaking

      removed the enum value twoFactorTypeId from the query request parameter sortBy

    • info

      added the new enum value libraryQuotaFormatted to the query request parameter sortBy

    • info

      added the new enum value twoFactorDescription to the query request parameter sortBy