Reports
The reports function allows you to generate and download reports based on the data held within your Authentication Cloud instance. This gives you a simple way to extract relevant data in a structured format.
You can access reports on the Management Console under the Reports sidebar item, then choose from the available Report types. You can then set the time period to include, and download the report in a .csv file format.
CSV exports are protected from code injection through a full escaping solution. See How are the logs and reports functions protected from code injection for details.
You can find a detailed description of each available report type in the following sections of this page.
User authentications report
User authentications reports show the details of all authentication events within the defined time period. Events are sorted by the authenticationDate field value in descending order. The report contains the following fields for each authentication event:
| Column | Required/Optional | Details |
|---|---|---|
userId | optional | The ID of the user. |
username | optional | The name of the user. |
registrationDate | required | The date when the user was registered in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
authenticationDate | required | The date of the authentication event in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
authenticatorId | optional | The ID of the authenticator. |
authenticationChannel | optional | The authentication channel according to the authentication method used. |
authenticationDevice | optional | The name of the authenticator used. |
authenticationSdkVersion | optional | The version of the SDK used. It can be used to check if the minimum required version is satisfied. |
Registered users report
Registered users reports show the details of all registration events within the defined time period. Events are sorted by the firstRegistrationDate field value in ascending order. The report contains the following fields for each registration event:
| Column | Required/Optional | Details |
|---|---|---|
userId | required | The ID of the user. |
username | optional | The name of the user. |
firstRegistrationDate | required | The date of the user's earliest registration event within the defined time period in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
lastAuthenticationDate | optional | The date of the user's most recent authentication event in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
lastAuthenticationChannel | optional | The authentication channel according to the authentication method used in the user's most recent authentication event. |
lastAuthenticationDeviceName | optional | The name of the authenticator used in the user's most recent authentication event. |
lastAuthenticationSdkVersion | optional | The version of the SDK used in the user's most recent authentication event. It can be used to check if the minimum required version is satisfied. |
Active users report
Active users reports list all active users in the system and the details of their last registration or authentication event between two defined dates. Users are sorted by the userId field value in ascending order. The report contains the following fields for each event:
| Column | Required/Optional | Details |
|---|---|---|
userId | required | The ID of the user. |
username | optional | The name of the user. |
lastActivityType | required | The type of the user's most recent activity within the defined time period. |
lastActivityDate | optional | The date of the user's most recent activity within the defined time period in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
lastActivityChannel | optional | The authentication channel according to the authentication method used for the user's most recent activity. |
lastActivityDeviceName | optional | The name of the authenticator used for the user's most recent activity. |
lastActivitySdkVersion | optional | The version of the SDK used for the user's most recent activity. It can be used to check if the minimum required version is satisfied. |
Audit trail report
The audit trail report contains details of all data changes performed by both users and administrators between 2 defined dates. Events are sorted by the modifiedOn field value in descending order. The report contains the following fields for each event:
| Column | Required/Optional | Details |
|---|---|---|
dataType | required | The data types affected by the modification. For example: USER, AUTHENTICATOR. |
id | optional | The ID of the data affected by the modification. |
name | optional | The name of the data affected by the modification. |
actionType | required | The action type of the modification. For example: CREATE, DELETE. |
value | optional | The value that the user changed the record to. In the case of deletion, the value is NULL. |
modifiedBy | optional | The identifying information of the management console user or the end-user that made the change. |
modifiedOn | required | The date and time when the modification happened in the UTC timezone. The format of the date is: YYYY-MM-DD HH24:MI:SS.ZZZ. |
Instance availability report
The instance availability report shows the availability percentage of the instance in a defined time period. The report shows daily, or monthly aggregates in each row, depending on the selected resolution. Rows are sorted by the date field value in descending order. The report contains the following fields for each row:
| Column | Required/Optional | Details |
|---|---|---|
date | required | The date of the availability information. The format of the date is: YYYY-MM-DD. |
availability | required | The availability percentage of the service for the given day. Example: 100.00%, 99.99% |