Get Connection Profile Template

Retrieve a Connection Profile Template.

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

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.GetTemplateAsync(
            "id"
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.connectionProfiles().getTemplate("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connectionProfiles->getTemplate(
    'id',
);

from auth0.management import ManagementClient

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

client.connection_profiles.get_template(
    id="id",
)

require "auth0"

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

client.connection_profiles.get_template(id: "id")

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

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

fetch('https://{tenantDomain}/api/v2/connection-profiles/templates/{id}', 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/templates/{id}"

	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

{
  "id": "<string>",
  "display_name": "<string>",
  "template": {
    "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.

Path Parameters

id · string · required

ID of the connection-profile-template to retrieve.

Response

200

application/json

Connection Profile Template successfully retrieved.

id · string

The id of the template.

display_name · string

The user-friendly name of the template displayed in the UI.

template · object

The structure of the template, which can be used as the payload for creating or updating a Connection Profile.

Show child attributes