Auth0 API | Connections › Get All Connections

Connections

connections

Methods

Create A Connection ->

Connection

post/connections

Creates a new connection according to the JSON object received in body.

Delete A Connection ->

delete/connections/{id}

Removes a specific connection from your tenant. This action cannot be undone. Once removed, users can no longer use this connection to authenticate.

Get All Connections -> ConnectionsPageNumberPage<{ id, display_name, is_domain_connection, 5 more... }>

get/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.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

fields: string

Optional

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

from: string

Optional

Optional Id from which to start selection.

include_fields: boolean

Optional

true if the fields specified are to be included in the result, false otherwise (defaults to true)

include_totals: boolean

Optional

true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false.

name: string

Optional

Provide the name of the connection to retrieve

page: number

Optional

(minimum: 0)

The page number. Zero based

per_page: number

Optional

(maximum: 100, minimum: 1)

The amount of entries per page. Defaults to 100 if not provided

strategy: Array<

Optional

Provide 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"

"sms"

"soundcloud"

"thecity-sandbox"

"thecity"

"thirtysevensignals"

"twitter"

"untappd"

"vkontakte"

"waad"

"weibo"

"windowslive"

"wordpress"

"yahoo"

"yammer"

"yandex"

"auth0-adldap"

take: number

Optional

(maximum: 100, minimum: 1)

Number of results per page. Defaults to 50.

Response fields

UnionMember0 = Array<{ id, display_name, is_domain_connection, 5 more... }>

UnionMember1 = { connections, limit, start, 1 more... }

Request example

curl https://login0.local.dev.auth0.com/api/v2/connections \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

[
  {
    "id": "id",
    "display_name": "display_name",
    "is_domain_connection": true,
    "metadata": {
      "foo": "bar"
    },
    "name": "name",
    "options": {
      "foo": "bar"
    },
    "realms": [
      "string"
    ],
    "strategy": "strategy"
  }
]

Get A Connection ->

Connection

get/connections/{id}

Retrieve details for a specified connection along with options that can be used for identity provider configuration.

Update A Connection ->

Connection

patch/connections/{id}

Update details for a specific connection, including option properties for identity provider configuration.

Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option.

Domain types

Connection = { id, display_name, enabled_clients, 6 more... }

Connections

Scim Configuration

connections.scim_configuration

Methods

Create A Scim Configuration -> { connection_id, connection_name, created_at, 5 more... }

post/connections/{id}/scim-configuration

Create a scim configuration for a connection.

Delete A Connection S Scim Configuration ->

delete/connections/{id}/scim-configuration

Deletes a scim configuration by its connectionId.

Get A Connection S Scim Configuration ->

ScimConfiguration

get/connections/{id}/scim-configuration

Retrieves a scim configuration by its connectionId.

Patch A Connection S Scim Configuration -> { connection_id, connection_name, created_at, 5 more... }

patch/connections/{id}/scim-configuration

Update a scim configuration by its connectionId.

Domain types

ScimConfiguration = { connection_id, connection_name, created_at, 5 more... }

Connections Scim Configuration

Default Mapping

connections.scim_configuration.default_mapping

Methods

Get A Connection S Default Scim Mapping ->

DefaultMapping

get/connections/{id}/scim-configuration/default-mapping

Retrieves a scim configuration's default mapping by its connectionId.

Domain types

DefaultMapping = { mapping }

Connections Scim Configuration

Tokens

connections.scim_configuration.tokens

Methods

Create A Scim Token -> { token, created_at, scopes, 2 more... }

post/connections/{id}/scim-configuration/tokens

Create a scim token for a scim client.

Delete A Connection S Scim Token ->

delete/connections/{id}/scim-configuration/tokens/{tokenId}

Deletes a scim token by its connection id and tokenId.

Get A Connection S Scim Tokens -> Array<

ScimToken

get/connections/{id}/scim-configuration/tokens

Retrieves all scim tokens by its connection id.

Domain types

ScimToken = { created_at, last_used_at, scopes, 2 more... }

Connections

Status

connections.status

Methods

Check Connection Status ->

get/connections/{id}/status

Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message

Connections

Users

connections.users

Methods

Delete A Connection User ->

delete/connections/{id}/users

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.