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.Connections.CreateAsync(
            new CreateConnectionRequestContent {
                Name = "name",
                Strategy = ConnectionIdentityProviderEnum.Ad
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateConnectionRequestContent{
        Name: "name",
        Strategy: management.ConnectionIdentityProviderEnumAd,
    }
    mgmt.Connections.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ConnectionIdentityProviderEnum;
import com.auth0.client.mgmt.types.CreateConnectionRequestContent;

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

        client.connections().create(
            CreateConnectionRequestContent
                .builder()
                .name("name")
                .strategy(ConnectionIdentityProviderEnum.AD)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Connections\Requests\CreateConnectionRequestContent;
use Auth0\SDK\API\Management\Types\ConnectionIdentityProviderEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->create(
    new CreateConnectionRequestContent([
        'name' => 'name',
        'strategy' => ConnectionIdentityProviderEnum::Ad->value,
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.create({
        name: "name",
        strategy: "ad",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.create({
        name: "name",
        strategy: "ad",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "is_domain_connection": true,
  "metadata": {},
  "options": {
    "api_enable_groups": true,
    "api_enable_users": true,
    "attributes": {
      "email": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {
          "verification": {
            "active": true
          }
        },
        "unique": true
      },
      "phone_number": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {
          "verification": {
            "active": true
          }
        }
      },
      "username": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {},
        "validation": {
          "allowed_types": {
            "email": true,
            "phone_number": true
          },
          "max_length": 64.5,
          "min_length": 64.5
        }
      }
    },
    "authentication_methods": {
      "email_otp": {
        "enabled": true
      },
      "passkey": {
        "enabled": true
      },
      "password": {
        "enabled": true
      },
      "phone_otp": {
        "enabled": true
      }
    },
    "basic_profile": true,
    "configuration": {},
    "customScripts": {
      "change_email": "<string>",
      "change_password": "<string>",
      "change_phone_number": "<string>",
      "change_username": "<string>",
      "create": "<string>",
      "delete": "<string>",
      "get_user": "<string>",
      "login": "<string>",
      "verify": "<string>"
    },
    "disable_self_service_change_password": true,
    "discovery_url": "<string>",
    "enable_script_context": true,
    "enabledDatabaseCustomization": true,
    "ext_admin": true,
    "ext_agreed_terms": true,
    "ext_assigned_plans": true,
    "ext_groups": true,
    "ext_is_suspended": true,
    "ext_profile": true,
    "gateway_authentication": {
      "audience": "<string>",
      "method": "<string>",
      "secret": "<string>",
      "secret_base64_encoded": true,
      "subject": "<string>"
    },
    "id_token_session_expiry_supported": true,
    "id_token_signed_response_algs": [],
    "import_mode": true,
    "non_persistent_attrs": [
      "<string>"
    ],
    "oidc_metadata": {
      "acr_values_supported": [
        "<string>"
      ],
      "authorization_endpoint": "<string>",
      "claim_types_supported": [
        "<string>"
      ],
      "claims_locales_supported": [
        "<string>"
      ],
      "claims_parameter_supported": true,
      "claims_supported": [
        "<string>"
      ],
      "display_values_supported": [
        "<string>"
      ],
      "dpop_signing_alg_values_supported": [
        "<string>"
      ],
      "end_session_endpoint": "<string>",
      "grant_types_supported": [
        "<string>"
      ],
      "id_token_encryption_alg_values_supported": [
        "<string>"
      ],
      "id_token_encryption_enc_values_supported": [
        "<string>"
      ],
      "id_token_signing_alg_values_supported": [
        "<string>"
      ],
      "issuer": "<string>",
      "jwks_uri": "<string>",
      "op_policy_uri": "<string>",
      "op_tos_uri": "<string>",
      "registration_endpoint": "<string>",
      "request_object_encryption_alg_values_supported": [
        "<string>"
      ],
      "request_object_encryption_enc_values_supported": [
        "<string>"
      ],
      "request_object_signing_alg_values_supported": [
        "<string>"
      ],
      "request_parameter_supported": true,
      "request_uri_parameter_supported": true,
      "require_request_uri_registration": true,
      "response_modes_supported": [
        "<string>"
      ],
      "response_types_supported": [
        "<string>"
      ],
      "scopes_supported": [
        "<string>"
      ],
      "service_documentation": "<string>",
      "subject_types_supported": [
        "<string>"
      ],
      "token_endpoint": "<string>",
      "token_endpoint_auth_methods_supported": [
        "<string>"
      ],
      "token_endpoint_auth_signing_alg_values_supported": [
        "<string>"
      ],
      "ui_locales_supported": [
        "<string>"
      ],
      "userinfo_encryption_alg_values_supported": [
        "<string>"
      ],
      "userinfo_encryption_enc_values_supported": [
        "<string>"
      ],
      "userinfo_endpoint": "<string>",
      "userinfo_signing_alg_values_supported": [
        "<string>"
      ]
    },
    "passkey_options": {
      "local_enrollment_enabled": true,
      "progressive_enrollment_enabled": true
    },
    "password_complexity_options": {
      "min_length": 64
    },
    "password_dictionary": {
      "enable": true,
      "dictionary": [
        "<string>"
      ]
    },
    "password_history": {
      "enable": true,
      "size": 12
    },
    "password_no_personal_info": {
      "enable": true
    },
    "password_options": {
      "complexity": {
        "character_types": [],
        "min_length": 36
      },
      "dictionary": {
        "active": true,
        "custom": [
          "<string>"
        ]
      },
      "history": {
        "active": true,
        "size": 12
      },
      "profile_data": {
        "active": true,
        "blocked_fields": [
          "<string>"
        ]
      }
    },
    "precedence": [],
    "set_user_root_attributes": "on_each_login",
    "upstream_params": {},
    "validation": {
      "username": {
        "max": 123,
        "min": 2
      }
    }
  },
  "realms": [
    "<string>"
  ],
  "show_as_button": true
}
'

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "allow_missing_user_id": true,
    "cross_app_access": true
  },
  "cross_app_access_requesting_app": {
    "active": true
  },
  "cross_app_access_resource_app": {},
  "display_name": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "id": "con_0000000000000001",
  "is_domain_connection": true,
  "metadata": {},
  "name": "My connection",
  "options": {},
  "realms": [
    "<string>"
  ],
  "show_as_button": true,
  "strategy": "auth0"
}

Publier des connexions

deprecated

Crée une nouvelle connexion selon l’objet JSON reçu dans body.

Remarque : Si une connexion portant le même nom a été supprimée récemment et qu’un grand nombre d’utilisateurs y étaient associés, il se peut que la suppression soit toujours en cours. La création d’une nouvelle connexion portant ce nom avant la fin de la suppression peut échouer ou produire des résultats inattendus.

POST

https://{tenantDomain}/api/v2

connections

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.Connections.CreateAsync(
            new CreateConnectionRequestContent {
                Name = "name",
                Strategy = ConnectionIdentityProviderEnum.Ad
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateConnectionRequestContent{
        Name: "name",
        Strategy: management.ConnectionIdentityProviderEnumAd,
    }
    mgmt.Connections.Create(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ConnectionIdentityProviderEnum;
import com.auth0.client.mgmt.types.CreateConnectionRequestContent;

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

        client.connections().create(
            CreateConnectionRequestContent
                .builder()
                .name("name")
                .strategy(ConnectionIdentityProviderEnum.AD)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Connections\Requests\CreateConnectionRequestContent;
use Auth0\SDK\API\Management\Types\ConnectionIdentityProviderEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->connections->create(
    new CreateConnectionRequestContent([
        'name' => 'name',
        'strategy' => ConnectionIdentityProviderEnum::Ad->value,
    ]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.create({
        name: "name",
        strategy: "ad",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.connections.create({
        name: "name",
        strategy: "ad",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "display_name": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "is_domain_connection": true,
  "metadata": {},
  "options": {
    "api_enable_groups": true,
    "api_enable_users": true,
    "attributes": {
      "email": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {
          "verification": {
            "active": true
          }
        },
        "unique": true
      },
      "phone_number": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {
          "verification": {
            "active": true
          }
        }
      },
      "username": {
        "identifier": {
          "active": true
        },
        "profile_required": true,
        "signup": {},
        "validation": {
          "allowed_types": {
            "email": true,
            "phone_number": true
          },
          "max_length": 64.5,
          "min_length": 64.5
        }
      }
    },
    "authentication_methods": {
      "email_otp": {
        "enabled": true
      },
      "passkey": {
        "enabled": true
      },
      "password": {
        "enabled": true
      },
      "phone_otp": {
        "enabled": true
      }
    },
    "basic_profile": true,
    "configuration": {},
    "customScripts": {
      "change_email": "<string>",
      "change_password": "<string>",
      "change_phone_number": "<string>",
      "change_username": "<string>",
      "create": "<string>",
      "delete": "<string>",
      "get_user": "<string>",
      "login": "<string>",
      "verify": "<string>"
    },
    "disable_self_service_change_password": true,
    "discovery_url": "<string>",
    "enable_script_context": true,
    "enabledDatabaseCustomization": true,
    "ext_admin": true,
    "ext_agreed_terms": true,
    "ext_assigned_plans": true,
    "ext_groups": true,
    "ext_is_suspended": true,
    "ext_profile": true,
    "gateway_authentication": {
      "audience": "<string>",
      "method": "<string>",
      "secret": "<string>",
      "secret_base64_encoded": true,
      "subject": "<string>"
    },
    "id_token_session_expiry_supported": true,
    "id_token_signed_response_algs": [],
    "import_mode": true,
    "non_persistent_attrs": [
      "<string>"
    ],
    "oidc_metadata": {
      "acr_values_supported": [
        "<string>"
      ],
      "authorization_endpoint": "<string>",
      "claim_types_supported": [
        "<string>"
      ],
      "claims_locales_supported": [
        "<string>"
      ],
      "claims_parameter_supported": true,
      "claims_supported": [
        "<string>"
      ],
      "display_values_supported": [
        "<string>"
      ],
      "dpop_signing_alg_values_supported": [
        "<string>"
      ],
      "end_session_endpoint": "<string>",
      "grant_types_supported": [
        "<string>"
      ],
      "id_token_encryption_alg_values_supported": [
        "<string>"
      ],
      "id_token_encryption_enc_values_supported": [
        "<string>"
      ],
      "id_token_signing_alg_values_supported": [
        "<string>"
      ],
      "issuer": "<string>",
      "jwks_uri": "<string>",
      "op_policy_uri": "<string>",
      "op_tos_uri": "<string>",
      "registration_endpoint": "<string>",
      "request_object_encryption_alg_values_supported": [
        "<string>"
      ],
      "request_object_encryption_enc_values_supported": [
        "<string>"
      ],
      "request_object_signing_alg_values_supported": [
        "<string>"
      ],
      "request_parameter_supported": true,
      "request_uri_parameter_supported": true,
      "require_request_uri_registration": true,
      "response_modes_supported": [
        "<string>"
      ],
      "response_types_supported": [
        "<string>"
      ],
      "scopes_supported": [
        "<string>"
      ],
      "service_documentation": "<string>",
      "subject_types_supported": [
        "<string>"
      ],
      "token_endpoint": "<string>",
      "token_endpoint_auth_methods_supported": [
        "<string>"
      ],
      "token_endpoint_auth_signing_alg_values_supported": [
        "<string>"
      ],
      "ui_locales_supported": [
        "<string>"
      ],
      "userinfo_encryption_alg_values_supported": [
        "<string>"
      ],
      "userinfo_encryption_enc_values_supported": [
        "<string>"
      ],
      "userinfo_endpoint": "<string>",
      "userinfo_signing_alg_values_supported": [
        "<string>"
      ]
    },
    "passkey_options": {
      "local_enrollment_enabled": true,
      "progressive_enrollment_enabled": true
    },
    "password_complexity_options": {
      "min_length": 64
    },
    "password_dictionary": {
      "enable": true,
      "dictionary": [
        "<string>"
      ]
    },
    "password_history": {
      "enable": true,
      "size": 12
    },
    "password_no_personal_info": {
      "enable": true
    },
    "password_options": {
      "complexity": {
        "character_types": [],
        "min_length": 36
      },
      "dictionary": {
        "active": true,
        "custom": [
          "<string>"
        ]
      },
      "history": {
        "active": true,
        "size": 12
      },
      "profile_data": {
        "active": true,
        "blocked_fields": [
          "<string>"
        ]
      }
    },
    "precedence": [],
    "set_user_root_attributes": "on_each_login",
    "upstream_params": {},
    "validation": {
      "username": {
        "max": 123,
        "min": 2
      }
    }
  },
  "realms": [
    "<string>"
  ],
  "show_as_button": true
}
'

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "allow_missing_user_id": true,
    "cross_app_access": true
  },
  "cross_app_access_requesting_app": {
    "active": true
  },
  "cross_app_access_resource_app": {},
  "display_name": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "id": "con_0000000000000001",
  "is_domain_connection": true,
  "metadata": {},
  "name": "My connection",
  "options": {},
  "realms": [
    "<string>"
  ],
  "show_as_button": true,
  "strategy": "auth0"
}

Autorisations

Authorization

string

header

requis

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

Corps

name

string

requis

Le nom de la connexion. Doit commencer et se terminer par un caractère alphanumérique et ne peut contenir que des caractères alphanumériques et « - ». Longueur maximale : 128

Maximum string length: 128

Pattern: ^[a-zA-Z0-9](-[a-zA-Z0-9]|[a-zA-Z0-9])*$

strategy

enum<string>

requis

L’identifiant du fournisseur d’identité pour la connexion

Options disponibles:

ad,

adfs,

amazon,

apple,

dropbox,

bitbucket,

auth0-oidc,

auth0,

baidu,

bitly,

box,

custom,

daccount,

dwolla,

email,

evernote-sandbox,

evernote,

exact,

facebook,

fitbit,

github,

google-apps,

google-oauth2,

instagram,

ip,

line,

linkedin,

oauth1,

oauth2,

office365,

oidc,

okta,

paypal,

paypal-sandbox,

pingfederate,

planningcenter,

salesforce-community,

salesforce-sandbox,

salesforce,

samlp,

sharepoint,

shopify,

shop,

sms,

soundcloud,

thirtysevensignals,

twitter,

untappd,

vkontakte,

waad,

weibo,

windowslive,

wordpress,

yahoo,

yandex

authentication

object

Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.

Show child attributes

connected_accounts

object

Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.

Show child attributes

cross_app_access_requesting_app

object

Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.

Show child attributes

cross_app_access_resource_app

object

Paramètres Cross App Access - Resource App qui s’appliquent à cette connexion.

Show child attributes

display_name

string

Nom de la connexion utilisé dans la nouvelle expérience Universal Login

Maximum string length: 128

enabled_clients

string<client-id>[]

L’utilisation de cette propriété n’est PAS RECOMMANDÉE. Utilisez le endpoint PATCH /v2/connections/{id}/clients pour activer la connexion pour un ensemble de clients.

L’ID du client pour lequel la connexion doit être activée.

is_domain_connection

boolean

true fait passer la connexion au niveau du domaine afin que les applications tierces puissent l’utiliser. false ne fait pas passer la connexion au niveau du domaine; seules les applications first-party pour lesquelles la connexion est activée peuvent alors l’utiliser. (Valeur par défaut : false.)

metadata

object

Métadonnées associées à la connexion sous la forme d’un objet avec des valeurs de chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées est autorisé.

Show child attributes

options

object

Les options de la connexion (dépendent de la stratégie de connexion)

Show child attributes

realms

string<connection-realm>[]

Définit les realms pour lesquels la connexion sera utilisée (c.-à-d. les domaines de courriel). Si l’array est vide ou si la propriété n’est pas spécifiée, le nom de la connexion sera ajouté comme realm.

Le realm auquel cette connexion appartient

show_as_button

boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle ne pourra être utilisée que par HRD. (Valeur par défaut : false.)

Réponse

La connexion a été créée.

authentication

object

Configure l’objectif d’une connexion à utiliser pour l’authentification pendant la connexion.

Show child attributes

connected_accounts

object

Configurer l’usage d’une connexion pour les comptes connectés et Token Vault.

Show child attributes

cross_app_access_requesting_app

object

Configurez la connexion à utiliser comme application demandeuse pour Cross App Access.

Show child attributes

cross_app_access_resource_app

object

Paramètres de l’application de ressources Cross App Access qui s’appliquent à cette connexion.

Show child attributes

display_name

string

Nom de la connexion utilisé dans l’écran de connexion

enabled_clients

string[]

deprecated

Propriété DÉCONSEILLÉE. Utilisez le point de terminaison GET /connections/:id/clients pour obtenir les ID des clients pour lesquels la connexion est activée

L’ID client

string

défaut:con_0000000000000001

L’identifiant de la connexion

is_domain_connection

boolean

Vrai si la connexion est de niveau domaine

metadata

object

Métadonnées associées à la connexion sous la forme d’un objet avec des valeurs de chaîne (max. 255 caractères). Un maximum de 10 propriétés de métadonnées est autorisé.

Show child attributes

name

string

défaut:My connection

Le nom de la connexion

options

object

Pour renvoyer les options dans la réponse, le scope read:connections_options doit être présent

realms

string<connection-realm>[]

Définit les realms pour lesquels la connexion sera utilisée (c.-à-d. les domaines de courriel). Si le tableau est vide ou si la propriété n’est pas précisée, le nom de la connexion sera ajouté comme realm.

Le realm auquel appartient cette connexion

show_as_button

boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience uniquement). Si faux, elle sera utilisable uniquement par HRD.

strategy

string

défaut:auth0

Le type de connexion, lié au fournisseur d’identité