How To: Make an API Call to Pull Back Cloud IdP Assessment Data

Version Affected: 26.2.1 and later

 

Overview

This describes how to call the Admin Console API to pull back environment information such as Datastores, Policies, and Realm information. Customers can do this themselves using a generated API key and the supplied PowerShell script, or by writing their own script against the API key. This requires IdP version 26.2.1 or later.

Making the API Call

1. On the Primary node only, create the following Windows System Environment Variable, with a randomly generated value: ADMIN_API_READONLY_API_KEY.

2. Reboot the Primary node.
3. Download the PowerShell script linked below. Below is an example of the cmdlet — if OutputDir is not specified, it defaults to C:\temp:

.\Export-Applications.ps1 -BaseUrl 'https://domain.Identity.SecureAuth.com' -ApiKey 'your-api-key' -OutputDir 'C:\Reports'

Download the script.


 

SecureAuth Knowledge Base Articles provide information based on specific use cases and may not apply to all appliances or configurations. Be advised that these instructions could cause harm to the environment if not followed correctly or if they do not apply to the current use case.

Customers are responsible for their own due diligence prior to utilizing this information and agree that SecureAuth is not liable for any issues caused by misconfiguration directly or indirectly related to SecureAuth products.