Obfuscate Customers
Overview
This API can be used to obfuscate customers asynchronously. Only one customer can be processed at any given time. As part of processing this API, all information of the customers provided in the request will be obfuscated from application.
- Since
- 12.6(1) ES2
APIs
| Method | URL | Description |
| POST | /ws/v1/core/customermgr/bulk/customer/obfuscate | Initiate an obfuscate on customers identified by CSV file. |
Permissions
All of the following are required:
- The user must have 'Edit' action on the customer resource.
- If "Customer departmentalization" setting is enabled in the application, then the customer being modified must belong to either the user's home department, or to the department where the user is a foreign user.
Licenses
The logged in user must have the following licenses:
Request
Request headers
| Name | Description | Allowed values | Default value |
| X-egain-session | Session ID obtained from Login API response header | N/A | N/A |
| Accept | Content type accepted by client. | application/xml or application/json | N/A |
| Content-Type | Media type sent by the client | application/xml or application/json | N/A |
| Accept-Language | Language locale accepted by client (used for locale specific fields in resource representation and in error responses) | Supported 'Accept-Language' header codes | default system language |
Request body
The request body can be in one of the below two formats:
-
XML / JSON representing the bulkOperation.
-
The bulkOperation must contain a file with content in base64 encoded format.
-
The file name must be "customers.zip".
-
Multipart form data. This must have a single part as below:
-
The part name must be "customers".
-
The file name must be "customers.zip".
Content of the uploaded file
The request body will be used to upload the zip file which will have the customer to be obfuscated. Below are the rules for the content of the zip file:
-
The zip file must contain a single file by name customers.csv. This file must contain all the customers to be obfuscated as part of this request.
-
Header: The first line of the file is the header.
-
The header must contain the attribute used to identify the customer. The name of this attribute must be 'id'.
-
Entries: All the lines in the file, except the header are entries.
-
Each entry must have id of the customer to be obfuscated.
-
The number of entries in the file must be less than or equal to 100.
Mandatory attributes in the csv file
| Name | Description |
| id | Id of the customer to be obfuscated |
Response
Response headers
| Name | Description | Possible values |
| X-egain-session | Session ID of the current user session | N/A |
| Content-Type | Media type of response body | application/xml or application/json |
| Location | Location of the new customer obfuscate status request | N/A |
HTTP status codes
Success Status codes
202 - Accepted
- The request is accepted for processing.
Failure Status codes
400 - Bad Request
- Unsupported query parameter(s) supplied.
- Unsupported value for query parameter(s) provided in the request body.
- Required query parameter(s) missing in the request body.
401 - Unauthorized
- X-egain-session request header is missing.
- Session is invalid or expired.
403 - Forbidden
- The user does not have sufficient permissions. Refer Permissions section for details.
500 - Internal server error
Examples:
Example 1 - Obfuscate a batch of customers
