Use Cases

Performing common administrative tasks using the PingID API with Windows PowerShell

Many PingID management features are available through the PingID API using Windows PowerShell.

Before you begin

About this task

While it may not be necessary to build a custom application, the PingID API can be helpful in performing common tasks through Windows Powershell. The linked .zip file contains scripts to run several common tasks.

Steps

  1. Download the pingid.properties file from PingOne for Enterprise.

    1. Log in to https://admin.pingone.com.

    2. Go to Setup → PingID → Client Integration.

    3. In the Integrate with PingFederate and other clients section, click Download.

  2. Download and configure the PowerShell scripts.

    1. Go to https://github.com/pingidentity/pingid-powershell-scripts.

    2. Click Clone or download → Download ZIP.

    3. Extract the .zip file on a server with PowerShell installed.

    4. Edit the pingid-api-helper.psl file to include the $org_alias, $use_benefit, and $token values from your pingid.properties file.

  3. Run administrative task PowerShell scripts.

    The .zip file contains several scripts that you can use to perform tasks similar to the following examples.

    Task Script

    Obtain user details

    PS C:\Scripts\pingid-powershell-scripts-master\scripts>./Get-User-Details -UserName <user name>

    Put user in temporary bypass mode

    PS C:\Scripts\pingid-powershell-scripts-master\scripts>./Toggle-User-Bypass -UserName <user name> -Hours 8

    Remove user from temporary bypass mode

    PS C:\Scripts\pingid-powershell-scripts-master\scripts>./Toggle-User-Bypass -UserName <user name>

    Remove a user from PingID

    PS C:\Scripts\pingid-powershell-scripts-master\scripts>./Delete-User -UserName <user name>

    If you need to change your PowerShell execution policy, refer to About Execution Policies.