Delete User by External ID

Overview

Use this API to delete a user. Administrator users can delete only one user at a time. Integrated users can also be deleted using this API.

For this API to execute successfully, the user being deleted:

  • Must not be logged into the eGain application.
  • Must be department level user.
  • Must not have any open activities.
  • Must not have any open cases.
  • Must not own any case bases.
  • Must not be used in any Email, Social or KB workflow.
  • Must not be used in any knowledge approval process.
  • Must not have any pending articles in the knowledge approval process.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • User must have 'Delete' permission on the user being deleted.
  • If logged in user is a global user, one of the following is required:
    • User must have 'Administer' permission on the department of the user being deleted.
    • User must have 'Manage partition resources' privileges.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

External ID

Example: Ext208920010
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
204

No content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

delete/user/ext-id/{id}
Request samples
Response samples
application/json
{
  • "code": "400-101",
  • "developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}