Sign in
user

User Delete

Delete user

delete/user/{userId}

Path parameters

userIdinteger required

Id of the user to delete

Query parameters

deleteAllItemsinteger

Flag indicating whether to delete all items owned by that user

reassignUserIdinteger

Reassign all items owned by this user to the specified user ID

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

{"stackTrail":"components:schemas:User:properties:playlists","oasType":"schema","type":"unknown","description":"An array of Playlists owned by this User"}
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

Changed in 2 of the 52 revisions of this API.123

  • 41c04de98ec53See the full diff
    • ○

      added the new optional query request parameter deleteAllItems

      new-optional-request-parameter

    • ○

      added the new optional query request parameter reassignUserId

      new-optional-request-parameter

    • ○

      added the media type application/json for the response with the status 204

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8e127539510412See the full diff
    • ▲

      removed the media type application/json for the response with the status 204

      response-media-type-removed

    • ●

      deleted the query request parameter deleteAllItems

      request-parameter-removed

    • ●

      deleted the query request parameter reassignUserId

      request-parameter-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog