See api-docs Menu

List Connectors

Use this API to return a list of connectors.

Connectors are used as a template for creating 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/connectors

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.

auth_method

number

Returns all connectors 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

[
  {
    "id": 114099,
    "name": "Amazon Connect",
    "auth_method": 2,
    "allows_new_parameters": false,
    "icon_url": "https://cdn-shadow.onlgn.net/images/icons/square/amazonConnect/old_original.png"
  },
  {
    "id": 50534,
    "name": "Amazon Web Services (AWS) Multi Role",
    "auth_method": 2,
    "allows_new_parameters": true,
    "icon_url": "https://cdn-shadow.onlgn.net/images/icons/square/amazonwebservices3multirole/old_original.png?1421095823"
  },
  ...
]

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 The connectors unique ID in OneLogin.
name The name of the connector.
auth_method An ID indicating the type of app. See above for possible values.
allows_new_parameters Indicates if apps created using this connector will be allowed to create custom parameters.
icon_url A link to the apps icon url.

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.

Get Connectors

curl 'https://api.<us_or_eu>>.onelogin.com/api/2/connectors' \
-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.