SSOReady automates away everything most companies will ever need to support their enterprise SAML and SCIM plans. With SSOReady’s SAML and SCIM APIs, you have everything you typically need.

For most SSOReady users, the typical lifecycle of how you use SSOReady is:

1. You sign up for the product at app.ssoready.com (one-time, ~1 minute)
2. You create a small number (often just two — dev and prod) of environments (one-time, ~5 minutes)
3. You implement SAML / SCIM by following the SAML quickstart or SCIM quickstart (one-time, ~1 day)
4. Every time you onboard a new enterprise customer, you (or your colleague, including nontechnical colleagues):
   • Create a new organization for that customer (~5 minutes), and
   • You give the customer a self-serve setup link, and the customer sets up their SAML and SCIM configuration (~1 minute for you, ~5 minutes for the customer)

For some large-scale SSOReady users, step (4) is a problem, and they want to automate it. If you have so many enterprises signing up that having to log into the SSOReady webapp to create an organization for each of them is a concern, then you may be one such SSOReady user.

With the Management API, you can automate away everything that would otherwise require a human to click around in the SSOReady web application. With the management API, the workflow for steps (4) would become:

• You programmatically create an organization using the Create Organization endpoint.
• You programmatically create a self-serve setup link using the Create Setup URL endpoint, and present that URL to your customer in your UI.

Management API Capabilities

The Management API can automate almost all operations that you can achieve by clicking around in the SSOReady web application. In particular, you can:

• Manage Organizations:
  • List Organizations
  • Create Organization
  • Get Organization
  • Update Organization
• Manage Self-Serve Setup URLs:
  • Create Setup URL
• Manage SAML Connections:
  • List SAML Connections
  • Create SAML Connection
  • Get SAML Connection
  • Update SAML Connection
• Manage SCIM Directories:
  • List SCIM Directories
  • Create SCIM Directory
  • Get SCIM Directory
  • Update SCIM Directory

Using the Management API

You can call the Management API using SSOReady’s HTTP API, or using SSOReady’s SDKs. Each endpoint’s API Reference listed in Management API Capabilities includes examples using the SDKs or HTTP API.

You can use the Management API using the same API keys you use when interacting with the SSOReady SAML and SCIM APIs. By default, API keys do not have access to the Management API. Creating API keys having access to the Management API is covered in SSOReady concepts: Environments: “Management API”.