Créer une connexion

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 comportait un grand nombre d’utilisateurs associés, sa suppression est peut-être 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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreateConnectionRequestContent{
        Name: "name",
        Strategy: management.ConnectionIdentityProviderEnumAd,
    }
    client.Connections.Create(
        context.TODO(),
        request,
    )
}

201

{
  "authentication": {
    "active": true
  },
  "connected_accounts": {
    "active": true,
    "cross_app_access": true
  },
  "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

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

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 · GA

Configure l’usage d’une connexion à utiliser pour l’authentification lors de la connexion.

Show child attributes

connected_accounts · object · GA

Configurez l’usage d’une connexion à utiliser pour Connected Accounts et Token Vault.

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 point de terminaison PATCH /v2/connections/{id}/clients pour activer la connexion pour un ensemble de clients.

L’id de l’application pour laquelle la connexion doit être activée.

is_domain_connection · boolean

true élève la connexion au niveau du domaine afin que des applications tierces puissent l’utiliser. false ne l’élève pas, de sorte que seules les applications de première partie pour lesquelles la connexion est activée peuvent l’utiliser. (Valeur par défaut : false.)

metadata · object

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

Show child attributes

options · object

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 le tableau 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 uniquement). Si false, elle ne pourra être utilisée que par HRD. (Valeur par défaut : false.)

Réponse

201

application/json

La connexion a été créée.

authentication · object · GA

Configure l’usage d’une connexion à utiliser pour l’authentification lors de la connexion.

Show child attributes

connected_accounts · object · GA

Configurez l’usage d’une connexion à utiliser pour Connected Accounts et Token Vault.

Show child attributes

display_name · string

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

enabled_clients · string[] · deprecated

Propriété obsolète. Utilisez le point de terminaison GET /connections/:id/clients pour obtenir les id des applications pour lesquelles la connexion est activée

L’ID client

id · string · défaut: con_0000000000000001

L’identifiant de la connexion

is_domain_connection · boolean

True si la connexion est de niveau domaine

metadata · object

Métadonnées associées à la connexion sous la forme d’un objet contenant des valeurs de type 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 (p. ex. : les domaines de courriel). Si le tableau 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.

strategy · string · défaut: auth0

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