How Can We Help?
To get audit details for an account, use the ‘audit-data’ Query API as follows:
API Name – audit-data
Format – GET /config/accounts/{account-id}/audit-data
Input Parameters
| Type | Name | Description | Schema | Mandatory/ Optional |
| Path | accountId | ID or Identifier of an Account | string | Mandatory |
| Query | activityType | Type of an activity. Feature in which HEAL detects a change. It can be ‘all’ or you may specify one or more activities. More than one activity is separated by a comma symbol. Activities are case-sensitive. | string | Optional |
| Query | from | Time Range. It needs to be in GMT format. | string | Mandatory |
| Query | to | string | Mandatory |
Output Parameters
- Activity Type – Feature in which HEAL detects a change. It can be all or you may specify one or more activities. More than one activity is separated by a comma symbol.
- Sub-Activity Type – Sub-feature in the main feature. It indicates the activity performed in the main feature.
- Operation Type – Operation type can be one of the following – CREATE/UPDATE/DELETE/ACTION This is the operation performed in main feature.
- Activity time – Date and time at which the change happens.
- Updated by – Individual who performs the operation.
- Old Value – Previous state of the activity. In case the Activity Type is User Management or My Profile, it gives the old value of the attribute which is updated and the keys which are related to the attribute and values of those keys. Keys help in identifying the attribute.
- New Value – Current state of the activity. In case the Activity Type is User Management or My Profile, it gives the new value of the attribute which is updated and the keys which are related to the attribute and values of those keys. Keys help in identifying the attribute.
- User Name – Name of the user.
- First Name – Initial name of the user.
- Last Name – Last name of the user.
- Status – Status of the user. It can be Enabled or Disabled.
- User Role – Specific role of the user. As per the role, activities are performed.
Sample Input
https://<keycloak_host>:<keycloak_port>/appsone-query-api/v1.0/config/accounts/2/audit-data?from=2021-01-01 17:29:07&to=2021-01-05 07:50:07&activityType=User Management