User anonymization. REST API
- Andrei Pisklenov
REST API
Method, path | Query parameters | Body | Response | Notes |
|---|---|---|---|---|
POST /rest/actonic-gdpr/1.0/data-cleaner-template/:id | Template ID to update | {
"id":, // template id (long)
"name":"", // template name (string)
"jql":"", // scope, JQL expression (string)
"objects":[], // field names (array of strings)
"notificationType":"" // notification type (string)
}
| 200: {
"id":, - template id (long)
"enabled":, - template state (boolean)
"isDraft":, - is the template is draft (boolean)
"name":"", - template name (string)
"jql":"", - scope, JQL expression (string)
"objects":[], - field names (array of strings)
"dataRulesCount":, - number of rules (long)
"notificationType":"", - notification type (string)
"notificationParameters":{}, - notification parameters (object)
"issueCount":, - number of issues (long)
"isDeleting":, - is the template is deleted (boolean)
} | Update template for new anonymization process |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/rules | none | {
"templateId":, // template id (long)
"enabled":, // rule state (boolean)
"name":"", // rule name (string)
"searchType":"", // search type (string)
"searchString":"", // search string, what to search (string)
"replaceType":"", // replace type (string)
"replaceString":"" // replace string, what to replace (string)
} | 200:
| Add a new rule for quick user anonymization template |
GET /rest/actonic-gdpr/1.0/data-cleaner-template/anonymizer/custom-anonymizers | none | none | 200: | Get a list of registered anonymizers, provided by Actonic or 3rd party apps |
POST /rest/actonic-gdpr/1.0/data-cleaner-template/post-function | none | 200: Empty response | Add post-function to launch selected anonymizers after the main anonymization process | |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/task | none |
| 200: | Add a task to start a search or anonymization by a given template |
Usage Example
For anonymization of “User A” by replacing them to “User B”
Method, path | Query parameters | Body | Response | Notes |
|---|---|---|---|---|
POST /rest/actonic-gdpr/1.0/data-cleaner-template/-1 | "-1" template ID, always static for quick user anonymization template |
| 200: | Update template for new anonymization process. Use :id "-1" for quick user anonymization template |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/rules | none | 200: | Add a rule for user name replacement from “user1” to “user2”. It should be repeated for all the anonymized users. | |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/rules | none | 200: | Add a rule for display name replacement from “User A” to “User B”. It should be repeated for all the anonymized users. | |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/rules | none | 200: | Add a rule for email replacement from “user1@users.com” to “user2@users.com”. It should be repeated for all the anonymized users. | |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/rules | none |
| 200: | Add a rule for user mention replacement in text fields from “[~user1]” to “[~user2]”. It should be repeated for all the anonymized users. |
GET /rest/actonic-gdpr/1.0/data-cleaner-template/anonymizer/custom-anonymizers | none | none | 200: | Get a list of registered anonymizers, provided by Actonic or 3rd party apps. We will use it for built-in anpnymization post functions which process shared objects, like filters, dashboards, etc. |
POST /rest/actonic-gdpr/1.0/data-cleaner-template/post-function | none | 200: Empty response | Add post-function to launch shared object anonymization after the main anonymization process | |
PUT /rest/actonic-gdpr/1.0/data-cleaner-template/task | none |
| 200:
| Add a task to start a search or anonymization by a given template |