One Identity Safeguard is built to integrate with your existing systems. It is built for automation to facilitate your initial deployment and your on-going administration of the product. The key to automating and integrating with Safeguard is to become comfortable using the APIs, the open source SDKs, and the scripting libraries created to support those APIs.
One Identity open source projects are supported through One Identity GitHub issues and the One Identity Community. This includes all scripts, plugins, SDKs, modules, code snippets or other solutions. For assistance with any One Identity GitHub project, please raise a new Issue on the issues page of that particular One Identity GitHub project. For questions on this API tutorial or the hands on labs, you may raise an issue on the issues page of this repository, or you may also visit the One Identity Community to ask your questions. Requests for assistance made through official One Identity Support will be referred back to GitHub and the One Identity Community forums where those requests can benefit all users.
Safeguard for Privileged Passwords 7.X hosts both the v3 and v4 APIs. New coding projects should target the v4 API, and existing projects can be migrated over time. Notification will be given to customers many releases in advance of any plans to remove the v3 API. There are currently no plans to remove the v3 API.
Safeguard for Privileged Passwords (SPP) is built with an API-first design. This means that all product functionality is initially exposed as a public API before it is added to any user interface. All SPP functionality (100%) is available via the SPP API. There are even a few things that can ONLY be done via the SPP API.
The SPP UI is built for day to day operations, but some administrative tasks are actually more effectively performed via the SPP API. For example, an administrator can import assets, accounts, or users using the SPP UI, but using the SPP API or one of our open source scripting frameworks, such a safeguard-ps, is the best way to bulk import objects.
The following tutorials will help you to understand the SPP product design and how to manipulate SPP via the SPP API. Each tutorial includes some instruction and hands-on lab exercises to help you get familiar with new technologies and techniques. Upon completing these tutorials, you will find that using the SPP API and open source tools to deploy, automate, monitor, and support your Safeguard installation is easy and effective.
- SPP 1 -- Introduction to the SPP API
- SPP 2 -- Using Swagger UI to call the SPP API
- SPP 3 -- Using Postman to call the SPP API
- SPP 4 -- Scripting with safeguard-ps
- SPP 5 -- Scripting with safeguard-bash
- SPP 6 -- SPP integration using SafeguardDotNet
For additional information following the tutorial, please visit our open source projects also hosted on GitHub: