Audit Aternity Access with REST API (version 1.0)

USER_AUDIT returns a list of users and the times that they successfully signed in, so that you can audit or monitor the people accessing Aternity.

For example, you can check that all Application Owners (AOs) monitor their product performance regularly in Aternity by calling this API and filtering for the AO department. This returns the list of AOs and times that they signed in to Aternity.

Each returned entry from USER_AUDIT represents a successful sign in from the Aternity sign-in page, or via SSO with an identity provider. The entry provides the time the event took place, and the Aternity username.

Note

You can access data using this API (retention) going back up to 90 days. If you do not add a relative_time filter, by default it returns data for the past day.

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Examples

To access this API from a browser, Excel or Power BI (learn more), enter <base_url>/USER_AUDIT

To see all the times when a specific user signed in to Aternity, select to display the Timeframe column and filter for a specific username:

.../USER_AUDIT?$select=TIMEFRAME&$filter=USER_NAME eq 'jsmith@company.com'

To see all users who signed in with SSO in the week just passed, enter:

.../USER_AUDIT?$select=USER_NAME&$filter=METHOD eq 'SamlUser' and relative_time(last_week)

Supported Parameters

You can view the data by entering the URL into Excel, into a browser, or into or any OData compatible application such as Power BI.

You can add parameters to the URL to filter the returned data, by adding a question mark (?) followed by a parameter and value, such as .../API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../API_NAME?$format=xml&$top=5.

Parameter Description
$select=

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3

$filter=

Use $filter to insert conditions that narrow down the data, to return only entries where those conditions are true..

To limit the timeframe of a query, add $filter=relative_time() like, .../API_NAME?$filter=relative_time(last_x_hours) or (last_x_days). Learn more.

Create conditions with operators: and, or, eq (equals) gt (greater than), ge (greater than or equal), lt (less than), le (less than or equal), ge (greater than or equal to), ne (not equal to), le (less than or equal to), not and contains. Use operators with parentheses to group conditions logically: .../API_NAME?$filter=(COLUMN1 eq 'value1' or COL2 neq 'val2') and (COL3 gt number) and not (COL4 eq 'val4' or contains(COL5,'val5'))

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for testing the raw data in a web browser. For example: .../API_NAME?$format=xml

$orderby=

Use $orderby to sort the returned data according to the value you choose. For example, .../API_NAME?$orderby=LOCATION

$top=

Use $top (lower case only) when you are initially testing the response of the API by returning the first few entries.

For example, to return the first five entries (not sorted), use: ...API_NAME?$top=5

$search is NOT supported.

Do not use $search in Aternity's REST APIs.

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Output

Each returned entry from USER_AUDIT represents a successful sign in from the Aternity sign-in page, or via SSO with an identity provider. The entry provides the time the event took place, and the Aternity username.

You can access data using this API (retention) going back up to 90 days. If you do not add a relative_time filter, by default it returns data for the past day.

The returned columns are:

Account_ID,Account_Name,Action,Custom_Attribute_1 - 6,Entity_Type,Method,Timeframe,User_Name