Delete User

Description

The deleteUser endpoint is used to delete a user.

Request¶

Endpoint¶

ui/v1/deleteUser

Method¶

POST

Headers¶

Content-Type: application/json

ELEMENT	DESCRIPTION
id	Required User Id
userName	Required Username of the user
status	Required User status EX: ACTIVE

Body¶

{
    "id": 985,
    "userName": "madmin1.puntacana",
    "status": {
        "name": "ACTIVE"
    }
}

Response¶

{
    "country": null,
    "addressLine1": null,
    "addressLine2": null,
    "addressLine3": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "streetNumber": null,
    "streetName": null,
    "id": 985,
    "userName": "madmin1.puntacana",
    "password": null,
    "status": {
        "name": "ACTIVE"
    },
    "firstName": null,
    "lastName": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "jobTitle": null,
    "department": null,
    "roles": [],
    "userChannelMap": [],
    "oldEmail": null,
    "email": null,
    "locale": null,
    "lastLoginDateTime": null,
    "securityQuestionsEnrolledInd": false,
    "createdUserId": null,
    "lastModifiedUserId": null,
    "firstLoginDateTime": null,
    "maximumAllowedLoginDays": null,
    "organizationName": null,
    "forceChangePasswordInd": false,
    "originalUserId": null,
    "loyaltyStatus": {
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "loyaltyEnrolledDateTime": null,
    "loyaltyTierLevel": {
        "name": "NONE"
    },
    "totalOutstandingPoints": null,
    "forgotPasswordGeneratedDateTime": null,
    "numberOfFailedLoginAttempts": 0,
    "numberOfFailedForgotPasswordAttempts": 0,
    "changePasswordDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "merchantId": null,
    "createdDateTime": null,
    "forceChangeSecurityQuestionsInd": false,
    "passwordNeverExpiresInd": false,
    "phoneCountryCallingCodeId": null,
    "mobileCountryCallingCodeId": null,
    "faxCountryCallingCodeId": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "namePrefix": null,
    "nameSuffix": null,
    "middleInitial": null,
    "paymentAction": null,
    "mobilePhoneCarrierType": null,
    "transactionCategory": null,
    "textMessageType": null,
    "customer": null,
    "oneTimePasscode": null,
    "oneTimePasscodeCreatedDateTime": null,
    "numberOfFailedOneTimePasscodeAttempts": 0,
    "gender": null,
    "message": {
        "code": "24",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "USER_STATUS_DELETION_SUCCESS",
        "parameters": [
            {
                "name": "USER_NAME",
                "value": "madmin1.puntacana"
            }
        ]
    },
    "customerId": null,
    "address": null,
    "fullName": null,
    "minimumPasswordLength": null,
    "minimumLowercaseAlphabets": null,
    "minimumUppercaseAlphabets": null,
    "minimumNumerics": null,
    "minimumSpecialCharacters": null,
    "sessionId": null,
    "uiType": null,
    "customerName": null,
    "customerNumber": null,
    "geolocation": null,
    "currentPassword": null,
    "reEnterPassword": null,
    "reEnterEmail": null,
    "merchantName": null,
    "language": null,
    "merchantCode": null,
    "passwordAlreadyExists": false,
    "currentPasswordValid": false,
    "principal": null,
    "userSession": null,
    "selectedRoles": null,
    "numberOfInactiveLoginDays": null
}

Updated As Of Version 6.1.1