Example: Getting a List of Users with Certify Results API

This example shows you how to get a list of users for auditing purposes with Certify Results API.

Prerequisites

1. Generate a token in Certify Results API. For more information, see Generating a Token in Certify Results API.
2. If Microsoft® Excel® will be used to access data from Certify Results API, install the Microsoft Power Query plug-in. For more information, see https://support.microsoft.com/en-us/office/introduction-to-microsoft-power-query-for-excel-6e92e2f4-2079-4e1f-bad5-89f6269cd605 and https://www.microsoft.com/en-us/download/details.aspx?id=39379&CorrelationId=0a1fb29a-5281-4097-b3e6-431367168cc1.

API Endpoints

Microsoft Excel Example

1. Open Certify Results API Swagger page:

   http(s)://yourdomain/CertifyResultsAPI/swagger/ui/index

2. Generate a token. For more information, see Generating a Token in Certify Results API.

3. Add the API token to Swagger.

   

4. Enter the required inputs to the GET /api/v1/users/GetAll endpoint as described in the above API Endpoints section.

5. Click the Try it out! button.

6. Copy the URL that was generated in the Request URL section.

   Example: http://certifydemo/CertifyResultsAPI/api/v1/users/GetAll

7. Open Microsoft Excel.

8. Click the Data tab.

9. From the Data tab, click the From Web button.

   

   The From Web dialog opens.

   

10. Select the Advanced option.

    

11. In the URL parts field, paste the resultsAPIResultsFolderUrl value.

12. From the HTTP request header parameters (optional) field, enter token.

13. In the second field, paste the resultsAPIToken value.

14. Click OK.

15. From the Query window in Microsoft Excel, edit the query name to Result Charts.

    

16. Click on the List link next to Results column.

    

17. Click the To Table button to expand the data.

    

    The To Table dialog opens.

    

18. Click OK.

19. In the Queries window, click the Expand button on the right corner of the first column.

    

20. Select the following columns:
21. UserName
22. FirstName
23. LastName
24. EmailID
25. Deleted
26. Disabled
27. Role
28. Locked
29. ExpirationDate

21. Click the Close & Load button.

    

    A new sheet with the tabular data is populated.

    

    The data can be used to create pivot tables and charts using Excel.

22. Save the file.

23. In the Data tab, click the Refresh All button to pull live data.

    

 

Related Topics