Créer une requête de compte connecté

curl --request POST \
  --url https://{host}/me/v1/connected-accounts/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "<string>",
  "redirect_uri": "<string>",
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "resource": "<string>",
    "ui_locales": "<string>"
  },
  "code_challenge": "<string>",
  "code_challenge_method": "S256",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "state": "<string>"
}
'

import requests

url = "https://{host}/me/v1/connected-accounts/connect"

payload = {
    "connection": "<string>",
    "redirect_uri": "<string>",
    "authorization_params": {
        "acr_values": "<string>",
        "audience": "<string>",
        "id_token_hint": "<string>",
        "login_hint": "<string>",
        "max_age": 1073741823,
        "resource": "<string>",
        "ui_locales": "<string>"
    },
    "code_challenge": "<string>",
    "code_challenge_method": "S256",
    "scopes": ["openid", "offline_access", "read:tasks", "write:tasks"],
    "state": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connection: '<string>',
    redirect_uri: '<string>',
    authorization_params: {
      acr_values: '<string>',
      audience: '<string>',
      id_token_hint: '<string>',
      login_hint: '<string>',
      max_age: 1073741823,
      resource: '<string>',
      ui_locales: '<string>'
    },
    code_challenge: '<string>',
    code_challenge_method: 'S256',
    scopes: ['openid', 'offline_access', 'read:tasks', 'write:tasks'],
    state: '<string>'
  })
};

fetch('https://{host}/me/v1/connected-accounts/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/connected-accounts/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection' => '<string>',
    'redirect_uri' => '<string>',
    'authorization_params' => [
        'acr_values' => '<string>',
        'audience' => '<string>',
        'id_token_hint' => '<string>',
        'login_hint' => '<string>',
        'max_age' => 1073741823,
        'resource' => '<string>',
        'ui_locales' => '<string>'
    ],
    'code_challenge' => '<string>',
    'code_challenge_method' => 'S256',
    'scopes' => [
        'openid',
        'offline_access',
        'read:tasks',
        'write:tasks'
    ],
    'state' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{host}/me/v1/connected-accounts/connect"

	payload := strings.NewReader("{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://{host}/me/v1/connected-accounts/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/connected-accounts/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "auth_session": "<string>",
  "connect_params": {
    "ticket": "<string>"
  },
  "connect_uri": "<string>",
  "expires_in": 2
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

POST

https://{host}/me/v1

connected-accounts

connect

Créer une requête de compte connecté

curl --request POST \
  --url https://{host}/me/v1/connected-accounts/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "<string>",
  "redirect_uri": "<string>",
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "resource": "<string>",
    "ui_locales": "<string>"
  },
  "code_challenge": "<string>",
  "code_challenge_method": "S256",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "state": "<string>"
}
'

import requests

url = "https://{host}/me/v1/connected-accounts/connect"

payload = {
    "connection": "<string>",
    "redirect_uri": "<string>",
    "authorization_params": {
        "acr_values": "<string>",
        "audience": "<string>",
        "id_token_hint": "<string>",
        "login_hint": "<string>",
        "max_age": 1073741823,
        "resource": "<string>",
        "ui_locales": "<string>"
    },
    "code_challenge": "<string>",
    "code_challenge_method": "S256",
    "scopes": ["openid", "offline_access", "read:tasks", "write:tasks"],
    "state": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    connection: '<string>',
    redirect_uri: '<string>',
    authorization_params: {
      acr_values: '<string>',
      audience: '<string>',
      id_token_hint: '<string>',
      login_hint: '<string>',
      max_age: 1073741823,
      resource: '<string>',
      ui_locales: '<string>'
    },
    code_challenge: '<string>',
    code_challenge_method: 'S256',
    scopes: ['openid', 'offline_access', 'read:tasks', 'write:tasks'],
    state: '<string>'
  })
};

fetch('https://{host}/me/v1/connected-accounts/connect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/connected-accounts/connect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection' => '<string>',
    'redirect_uri' => '<string>',
    'authorization_params' => [
        'acr_values' => '<string>',
        'audience' => '<string>',
        'id_token_hint' => '<string>',
        'login_hint' => '<string>',
        'max_age' => 1073741823,
        'resource' => '<string>',
        'ui_locales' => '<string>'
    ],
    'code_challenge' => '<string>',
    'code_challenge_method' => 'S256',
    'scopes' => [
        'openid',
        'offline_access',
        'read:tasks',
        'write:tasks'
    ],
    'state' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{host}/me/v1/connected-accounts/connect"

	payload := strings.NewReader("{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\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))

}

HttpResponse<String> response = Unirest.post("https://{host}/me/v1/connected-accounts/connect")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/connected-accounts/connect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection\": \"<string>\",\n  \"redirect_uri\": \"<string>\",\n  \"authorization_params\": {\n    \"acr_values\": \"<string>\",\n    \"audience\": \"<string>\",\n    \"id_token_hint\": \"<string>\",\n    \"login_hint\": \"<string>\",\n    \"max_age\": 1073741823,\n    \"resource\": \"<string>\",\n    \"ui_locales\": \"<string>\"\n  },\n  \"code_challenge\": \"<string>\",\n  \"code_challenge_method\": \"S256\",\n  \"scopes\": [\n    \"openid\",\n    \"offline_access\",\n    \"read:tasks\",\n    \"write:tasks\"\n  ],\n  \"state\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "auth_session": "<string>",
  "connect_params": {
    "ticket": "<string>"
  },
  "connect_uri": "<string>",
  "expires_in": 2
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

Autorisations

Authorization

string

header

requis

Les jetons Bearer et DPoP sont pris en charge selon la configuration de l’API

En-têtes

x-correlation-id

string

Un identifiant unique fourni par le client pour une opération donnée, utilisé pour corréler la requête dans les systèmes Auth0. La valeur apparaît sous references.correlation_id dans les journaux du locataire et est renvoyée dans l’en-tête x-correlation-id de la réponse. Les valeurs non valides ou trop longues sont ignorées silencieusement et remplacées par un UUID v4 généré. Évitez d’inclure des renseignements personnels identifiables (RPI).

traceparent

string

Un en-tête W3C Trace Context utilisé pour corréler la requête dans les traces distribuées. Lorsqu’il est fourni, la trace entrante est poursuivie et un nouveau span enfant est renvoyé dans l’en-tête traceparent de la réponse ; l’ID de trace apparaît aussi sous references.trace_id dans les journaux du locataire. Les valeurs malformées sont ignorées.

x-request-language

string

Indique la langue utilisée pour le contenu localisé généré lors du traitement de la requête (par exemple, les courriels OTP ou les messages SMS), à l’aide de l’une des langues prises en charge configurées pour le locataire.

Corps

application/json

Corps de la requête pour créer une requête de liaison de compte.

connection

string

requis

Le nom de la connexion à lier au compte (p. ex., 'google-oauth2', 'facebook').

Required string length: 1 - 128

redirect_uri

string<uri>

requis

L’URI de redirection à utiliser une fois le processus de connexion terminé.

Maximum string length: 2048

authorization_params

Authorization Parameters · object

Paramètres d’autorisation à envoyer au fournisseur d’identité (IdP) sous-jacent durant la requête d’autorisation. Ces paramètres influencent la façon dont l’IdP traite le flux d’autorisation et les permissions demandées.

Show child attributes

code_challenge

string

Le code challenge PKCE dérivé du code verifier.

Required string length: 43 - 128

code_challenge_method

string

La méthode utilisée pour dériver le code challenge. Obligatoire lorsque code_challenge est fourni.

Allowed value: "S256"

scopes

string[]

Définit les permissions que le client demande au fournisseur d’identité. Doit inclure les scopes standard utilisés pour identifier l’utilisateur (p. ex. 'openid', 'email', 'profile'), le scope requis pour obtenir des refresh tokens au besoin (p. ex. 'offline_access'), ainsi que tout scope personnalisé dont le client a besoin pour accéder à des ressources protégées.

Required array length: 1 - 100 elements

Required string length: 1 - 255

Exemple:

[
  "openid",
  "offline_access",
  "read:tasks",
  "write:tasks"
]

state

string

Une valeur opaque utilisée pour maintenir l’état entre la requête et le callback.

Required string length: 1 - 4096

Réponse

Requête de liaison de compte créée avec succès

auth_session

string

requis

L’identifiant de session d’authentification.

Maximum string length: 64

connect_params

object

requis

Paramètres à utiliser avec l’URI de connexion.

Show child attributes

connect_uri

string<uri>

requis

L’URI de base pour lancer le flux de liaison de compte.

expires_in

integer

requis

Le nombre de secondes avant l’expiration du ticket.

Plage requise: x >= 1

Factors

Authentication Methods

Connected Accounts

Créer une requête de compte connecté

Autorisations

En-têtes

Corps

Réponse