See api-docs Menu

List Apps

Use this API to return a list of all Apps in a OneLogin account.

Early Access Release

This API is currently in early preview release and may be subject to future breaking changes. If you’re interested in using this API please contact your account manager or our support team.

This call returns up to 1000 apps. Pagination is not available yet.

Resource URL

https://api.<us_or_eu>.onelogin.com/api/2/apps

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All.

Query Parameters

name

string

The name or partial name of the app to search for.

connector_id

number

Returns all apps based off a specific connector. See List Connectors for a complete list of Connector IDs.

auth_method

number

Returns all apps based of a given type.

  • 0 - Password
  • 1 - OpenId
  • 2 - SAML
  • 3 - API
  • 4 - Google
  • 6 - Forms Based App
  • 7 - WSFED
  • 8 - OpenId Connect

Sample Responses

[
  {
      "policy_id": null,
      "visible": true,
      "tab_id": null,
      "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
  },
  {
      "policy_id": null,
      "visible": true,
      "tab_id": 196885,
      "updated_at": "2018-10-05T19:53:05Z",
      "auth_method": 2,
      "notes": "",
      "name": "Amazon Web Services (AWS)",
      "created_at": "2017-09-28T02:38:14Z",
      "description": "Testing ",
      "connector_id": 30319,
      "allow_assumed_signin": false,
      "id": 707882
  },
  ...
]

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Indicates that the syntax of the request is good but a value supplied is not valid.

{
    "message": "invalid value in \"auth_method\"",
    "statusCode": 422,
    "name": "UnprocessableEntityError"
}

Response Elements

id Apps unique ID in OneLogin.
connector_id ID of the apps underlying connector.
name App name.
description Freeform description of the app.
notes Freeform notes about the app.
policy_id The security policy assigned to the app.
visible Indicates if the app is visible in the OneLogin portal.
auth_method An ID indicating the type of app. See above for possible values.
tab_id ID of the OneLogin portal tab that the app is assigned to.
created_at The date the app was created.
updated_at The date the app was last updated.
allow_assumed_signin Indicates whether or not administrators can access the app as a user that they have assumed control over.

Postman Collection

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

Download for the Apps API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

List Apps

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/apps' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Have a how-to question? Seeing a weird error? Ask us about it on StackOverflow.

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.