Create a connection profile

Create a Connection Profile.

POST 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 ManagementClient(
            token: "<token>"
        );

        await client.ConnectionProfiles.CreateAsync(
            new CreateConnectionProfileRequestContent {
                Name = "name"
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.connectionprofiles.requests.CreateConnectionProfileRequestContent;

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

        client.connectionProfiles().create(
            CreateConnectionProfileRequestContent
                .builder()
                .name("name")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\ConnectionProfiles\Requests\CreateConnectionProfileRequestContent;

$client = new Management(
    token: '<token>',
);
$client->connectionProfiles->create(
    new CreateConnectionProfileRequestContent([
        'name' => 'name',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.connection_profiles.create(
    name="name",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.connection_profiles.create(name: "name")

curl --request POST \
  --url https://{tenantDomain}/api/v2/connection-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {}
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {}}
    }
  })
};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"organization\": {},\n  \"connection_name_prefix_template\": \"<string>\",\n  \"enabled_features\": [],\n  \"connection_config\": {},\n  \"strategy_overrides\": {\n    \"pingfederate\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"ad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"adfs\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"waad\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"google-apps\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"okta\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"oidc\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    },\n    \"samlp\": {\n      \"enabled_features\": [],\n      \"connection_config\": {}\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

201

{
  "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.

Body

application/jsonapplication/x-www-form-urlencoded

name · string · required

The name of the connection profile.

Required string length: 1 - 50

organization · object

The organization of the connection profile.

Show child attributes

connection_name_prefix_template · string

Connection name prefix template.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

Available options: scim, universal_logout

connection_config · object

Connection profile configuration.

strategy_overrides · object

Strategy-specific overrides for this attribute

Show child attributes

Response

201

application/json

Connection profile successfully created.

id · string<connection-profile-id>

Connection Profile identifier.

name · string

The name of the connection profile.

Required string length: 1 - 50

organization · object

The organization of the connection profile.

Show child attributes

connection_name_prefix_template · string

Connection name prefix template.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

Available options: scim, universal_logout

connection_config · object

Connection profile configuration.

strategy_overrides · object

Strategy-specific overrides for this attribute

Show child attributes