See api-docs Menu

App API Early Preview

Welcome to the App API Early Preview. The purpose of this API is to allow administrators to save the state of their app configurations and provide a way to restore settings to a previous state. It is also useful for automating the replication of apps between environments or when you have multiple instances of a common app.

While it’s not a requirement we do recommend limiting use of this API to sandbox environments or at least be aware of your actions and that the interface of the API may contain breaking changes over the next few months.

What’s Included?

In the first iteration of this new API we have focused on the creation of SAML & OpenId Connect apps. You will find that you can create these app types, specify configuration and parameter values and also create new custom parameters if the connector type allows it.

This API does not yet support provisioning settings, roles, & rules. While it is possible to create Forms Based & WS-Fed apps, you may find issues with these app types as they have not been a primary focus for the early release.

A typical workflow for creating an app

In order to create an app you need to get an idea of what attributes are required for that type of app. The easiest way to do this is make use of the List Apps and Get App APIs.

First, filter the List Apps API using the name of an existing app to find that apps unique ID.

    "policy_id": null,
    "visible": true,
    "tab_id": null,
    "icon_url": "",
    "updated_at": "2019-05-15T16:09:54Z",
    "auth_method": 2,
    "notes": null,
    "name": "Amazon Web Services (AWS) Multi Role",
    "created_at": "2019-05-15T16:09:54Z",
    "description": "",
    "connector_id": 50534,
    "allow_assumed_signin": false,
    "id": 928533

Then use the Get App API to return the app’s full configuration.

You can now create a replica app by sending the complete app payload to the Get App API. Alternately you can send a subset of the required fields and let the app defaults take care of the rest.

  "connector_id": 108419,
  "name": "Sample OpenId Connect App",
  "description": "",
  "visible": true,
  "policy_id": 165278,
  "configuration": {
      "login_url": "",
      "redirect_uri": "",
      "access_token_expiration_minutes": 5,
      "refresh_token_expiration_minutes": 60,
      "token_endpoint_auth_method": 0,
      "oidc_application_type": 0

e.g. Create an OpenId Connect app

Keep in mind that your app replica will not carry over provisioning, roles and rules etc as these are not yet covered by the API.

Apps API Reference

App Resource

List all Apps

Get an App

Create a new App

Update an App

Delete a Parameter from an App

Delete an App

Connectors API Reference

List all Connectors

What’s Next?

Future iterations of this API will see additional endpoints for connectors and user/app assignment.

We will also focus in on supporting edge cases for OpenId Connect, SAML, and introduce official support for WS-Fed, Form Based Apps, and OneLogin Access.

We’ve worked hard to eliminate as many bugs and inconsistencies as possible with this API but we do anticipate that more issues will be found during the beta. We will keep you updated on enhancements and bug fixes as they are released.

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for the Apps API