Get Connection Profiles

Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.

GET https://{tenantDomain}/api/v2/connection-profiles

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.ConnectionProfiles.ListAsync(
            new ListConnectionProfileRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListConnectionProfileRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.connectionProfiles().list(
            ListConnectionProfileRequestParameters
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\ConnectionProfiles\Requests\ListConnectionProfileRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connectionProfiles->list(
    new ListConnectionProfileRequestParameters([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.connection_profiles.list(
    from="from",
    take=1,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.connection_profiles.list(
  from: "from",
  take: 1
)

curl --request GET \
  --url https://{tenantDomain}/api/v2/connection-profiles \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/connection-profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/connection-profiles"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

{
  "next": "<string>",
  "connection_profiles": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization": {},
      "connection_name_prefix_template": "<string>",
      "enabled_features": [],
      "connection_config": {},
      "strategy_overrides": {
        "pingfederate": {
          "enabled_features": [],
          "connection_config": {}
        },
        "ad": {
          "enabled_features": [],
          "connection_config": {}
        },
        "adfs": {
          "enabled_features": [],
          "connection_config": {}
        },
        "waad": {
          "enabled_features": [],
          "connection_config": {}
        },
        "google-apps": {
          "enabled_features": [],
          "connection_config": {}
        },
        "okta": {
          "enabled_features": [],
          "connection_config": {}
        },
        "oidc": {
          "enabled_features": [],
          "connection_config": {}
        },
        "samlp": {
          "enabled_features": [],
          "connection_config": {}
        }
      }
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 5.

Required range: 1 <= x <= 10

Response

200

application/json

Connection Profiles successfully retrieved.

next · string

A cursor to be used as the "from" query parameter for the next page of results.

connection_profiles · object[]

Show child attributes