Delete a User

post/delete/U

Deletes a specified user.

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
required
object
typedId
required
string non-empty
Responses
200

Example response

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
loginName
string non-empty
firstName
string non-empty
lastName
string non-empty
email
string non-empty
groups
any
businessRoles
any
activated
boolean
workflowEmailingActivated
boolean
noSession
boolean
requireTFA
boolean
receiveAdminEmail
boolean
ssoOnly
boolean
wizardDashboardName
any
firstLogin
boolean
additionalInfo1
any
additionalInfo2
any
additionalInfo3
any
additionalInfo4
any
emailLocale
string non-empty
defaultUserGroupEdit
string non-empty
defaultUserGroupViewDetails
string non-empty
productFilterCriteria
any
customerFilterCriteria
any
roleNames
Array of objects
allRoleNames
Array of objects
allGroups
Array of objects
createDate
string non-empty
createdBy
number
lastLogin
any
lastUpdateBy
number
extendedData
any
passwordExpiry
any
status
number
Request samples
application/json
{
  • "data": {
    • "typedId": "2147491062.U"
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "e2e-templates-node",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "2147491062.U",
        • "loginName": "john.pricer",
        • "firstName": "Tim",
        • "lastName": "Smith",
        • "email": "non@existent33.com",
        • "groups": null,
        • "businessRoles": null,
        • "activated": true,
        • "workflowEmailingActivated": true,
        • "noSession": true,
        • "requireTFA": true,
        • "receiveAdminEmail": true,
        • "ssoOnly": true,
        • "wizardDashboardName": null,
        • "firstLogin": false,
        • "additionalInfo1": null,
        • "additionalInfo2": null,
        • "additionalInfo3": null,
        • "additionalInfo4": null,
        • "emailLocale": "en",
        • "defaultUserGroupEdit": "Administrators",
        • "defaultUserGroupViewDetails": "Administrators",
        • "productFilterCriteria": null,
        • "customerFilterCriteria": null,
        • "roleNames": [ ],
        • "allRoleNames": [ ],
        • "allGroups": [ ],
        • "createDate": "2021-12-12T12:59:07",
        • "createdBy": 2147490696,
        • "lastLogin": null,
        • "lastUpdateBy": 2147490696,
        • "extendedData": null,
        • "passwordExpiry": null
        }
      ],
    • "status": 0
    }
}