Chat now with support
Chat with Support

We are currently experiencing issues on our phone support and are working diligently to restore services. For support, please sign in and create a case or email for assistance

One Identity Safeguard for Privileged Passwords 7.4.1 - Administration Guide

Introduction System requirements and versions Using API and PowerShell tools Using the virtual appliance and web management console Cloud deployment considerations Setting up Safeguard for Privileged Passwords for the first time Using the web client Home page Privileged access requests Appliance Management
Appliance Backup and Retention Certificates Cluster Global Services External Integration Real-Time Reports Safeguard Access Appliance Management Settings
Asset Management
Account Automation Accounts Assets Partitions Discovery Profiles Tags Registered Connectors Custom platforms Importing objects
Security Policy Management
Access Request Activity Account Groups Application to Application Cloud Assistant Asset Groups Entitlements Linked Accounts User Groups Security Policy Settings
User Management Reports Disaster recovery and clusters Administrator permissions Preparing systems for management Troubleshooting Frequently asked questions Appendix A: Safeguard ports Appendix B: SPP and SPS join guidance Appendix C: Regular Expressions

Custom platforms

The Asset Administrator adds a custom platform that includes uploading the custom platform script with the platform's commands and details. Auditors and Partition Administrators have read only rights. Custom platforms are global across all partitions. The custom platform can be selected when adding or updating an asset.

Navigate to:

  • web client: Asset Management > Connect and Platforms > Custom Platforms.

Use the following toolbar buttons to manage the custom platform settings.

Table 180: Custom Platforms: Toolbar
Option Description

Add a custom platform. For more information, see Adding a custom platform.


Remove the selected custom platform.

CAUTION: If the custom platform is associated with an asset, deleting the custom platform may halt password or SSH key validation and reset. A warning displays, indicating that the asset will be assigned to the Product platform type Other. Enter Force Delete to confirm the deletion.


Edit the selected platform.


Download the selected custom platform JSON script.


Update the list of custom platforms.

Related Topics

Creating a custom platform script

Adding a custom platform

Creating a custom platform script

A custom platform script identifies the platform's commands and associated details. Scripts are written in JSON. Scripts include metadata, parameters, function blocks, operations, and if/then constructs to authenticate to the platform and perform password or SSH key validation and reset. The custom platform script is uploaded when adding the custom platform.

An Asset Administrator can create an asset and accept default values in the associated custom script. If you later upload a new version of the custom platform script with different defaults, the asset defaults are not changed.

A delegated administrator cannot create a custom platform script.

Sample scripts

Sample custom platform scripts and command details are available at the following links available from the on GitHub:

CAUTION: Example scripts are provided for information only. Updates, error checking, and testing are required before using them in production. SPP checks to ensure the values match the type of the property that include a string, boolean, integer, or password (which is called secret in the API scripts). SPP cannot check the validity or system impact of values entered for custom platforms.

During development, check your JSON using a validator.

Adding a custom platform

It is the responsibility of the Asset Administrator to configure the rules so SPP handles custom platforms. The custom platform script must be available for uploading. For more information, see Creating a custom platform script..

To add a custom platform

  1. Have the custom platform script file available to upload.
  2. Navigate to:
    • web client: Asset Management > Connect and Platforms > Custom Platforms.
  3. Click  Add.
  4. These fields display:
    1. Name: Enter the unique name of the platform type, which may be a product name.
    2. Platform Script: Click Browse. Navigate to and select the script file. Click Open. The selected custom platform script file displays.

    3. Select the Allow Sessions Requests check box to allow session access requests. This check box is typically selected for SSH. Clear the Allow Sessions check box to prohibit session access requests.
  5. Click OK. If the custom platform script has errors, an error message like the following displays: Definition was not a valid json object .

Importing objects

SPP allows you to import a .csv file containing a set of accounts, assets, or users. A .csv template for import can be downloaded when you click  Import from the toolbar then click Download Template. The hard limit on file size 100 MiB. For more information, see Creating an import file.

To import Assets and Users

  1. Navigate to Assets or Users based on what data you are importing.

  2. Click Import from the toolbar.

  3. In the Import dialog, click Import to select an existing .csv file containing a list of objects to import.

  4. Click OK. SPP imports the objects into its database. The dialog will update as the import progresses and will alert you should any errors be found.

To import Accounts

  1. Navigate to Accounts.

  2. Click  Import from the toolbar.

    When importing accounts, you can import accounts, passwords and SSH keys separately. In this case, the Import button works as a drop-down. First, you need to import accounts. Select Import Accounts.

    Then, depending on what data you want to import, select Import Passwords or Import SSH Keys.

  3. In the Import dialog, click Import to select an existing .csv file containing a list of objects to import.

  4. Click OK. SPP imports the objects into its database. The dialog will update as the import progresses and will alert you should any errors be found.

When importing Starling User accounts from Microsoft Azure Active Directory (AAD), there are some expected differences.

For Starling type Identity Provider required fields are:

  • Name: This must have an entry of the user UserPrincipalName. Any other entry will be overwritten.

  • PrimaryAuthenticationProvider/Name: This will be the Starling provider name.

  • PrimaryAuthenticationProvider/Identity: This is the AAD user Id.

  • IdentityProvider/Name: This tells the import what type of user to import.

The following fields will be populated from the AAD user properties. An entry for these fields in the CSV import file will be overwritten by the information from AAD.

  • FirstName

  • LastName

  • EmailAddress

  • MobilePhone

  • WorkPhone

For more information about asset creation, see Adding an asset.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating