Get all connections
Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.
This endpoint supports two types of pagination:
- Offset pagination
- Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 connections.
Checkpoint Pagination
To search by checkpoint, use the following parameters:
from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The amount of entries per page. Defaults to 100 if not provided
1 <= x <= 100The page number. Zero based
x >= 0true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false.
Optional Id from which to start selection.
Number of results per page. Defaults to 50.
1 <= x <= 100Provide strategies to only retrieve connections with such strategies
ad, adfs, amazon, apple, dropbox, bitbucket, aol, auth0-oidc, auth0, baidu, bitly, box, custom, daccount, dwolla, email, evernote-sandbox, evernote, exact, facebook, fitbit, flickr, github, google-apps, google-oauth2, instagram, ip, line, linkedin, miicard, oauth1, oauth2, office365, oidc, okta, paypal, paypal-sandbox, pingfederate, planningcenter, renren, salesforce-community, salesforce-sandbox, salesforce, samlp, sharepoint, shopify, shop, sms, soundcloud, thecity-sandbox, thecity, thirtysevensignals, twitter, untappd, vkontakte, waad, weibo, windowslive, wordpress, yahoo, yammer, yandex, auth0-adldap Provide the name of the connection to retrieve
A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields
^((name)|(display_name)|(strategy)|(options)|(id)|(provisioning_ticket_url)|(metadata)|(show_as_button)|(clients)|(authentication)|(connected_accounts)|(cross_app_access_requesting_app)|(cross_app_access_resource_app)|(enabled_clients))(,((name)|(display_name)|(strategy)|(options)|(id)|(provisioning_ticket_url)|(metadata)|(show_as_button)|(clients)|(authentication)|(connected_accounts)|(cross_app_access_requesting_app)|(cross_app_access_resource_app)|(enabled_clients)))*$true if the fields specified are to be included in the result, false otherwise (defaults to true)
Response
The connections were retrieved.
- Option 1 · object[]
- Option 2 · object
- Option 3 · object
The name of the connection
Connection name used in login screen
In order to return options in the response, the read:connections_options scope must be present
The connection's identifier
The type of the connection, related to the identity provider
Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.
The realm where this connection belongs
True if the connection is domain level
Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD.
Metadata associated with the connection in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.
Configure the purpose of a connection to be used for authentication during login.
Configure the purpose of a connection to be used for connected accounts and Token Vault.