Create a connected account request

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>",
  "state": "<string>",
  "code_challenge": "<string>",
  "code_challenge_method": "S256",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "resource": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "ui_locales": "<string>"
  }
}
'

import requests

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

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

}

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

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

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

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

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

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

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

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

POST

https://{host}/me/v1

connected-accounts

connect

Create a connected account request

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>",
  "state": "<string>",
  "code_challenge": "<string>",
  "code_challenge_method": "S256",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "resource": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "ui_locales": "<string>"
  }
}
'

import requests

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

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

}

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

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

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

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

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

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

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

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

承認

Authorization

string

header

必須

Bearer and DPoP tokens are supported depending on the API configuration

ヘッダー

x-correlation-id

string

A client-provided unique identifier for a single operation, used to correlate the request across Auth0 systems. The value is surfaced under references.correlation_id in tenant logs and echoed back on the response's x-correlation-id header. Invalid or oversized values are silently dropped and replaced by a generated UUID v4. Avoid including personally identifiable information (PII).

traceparent

string

A W3C Trace Context header used to correlate the request across distributed traces. When supplied, the inbound trace is continued and a fresh child span is echoed back on the response's traceparent header; the trace ID is also surfaced under references.trace_id in tenant logs. Malformed values are ignored.

x-request-language

string

Specifies the language used for localized content generated while handling the request (such as OTP email or SMS messages), using one of the tenant's configured Supported Languages.

ボディ

application/json

Request body for creating an account connection request.

connection

string

必須

The name of the connection to link the account with (e.g., 'google-oauth2', 'facebook').

Required string length: 1 - 128

redirect_uri

string<uri>

必須

The URI to redirect to after the connection process completes.

Maximum string length: 2048

state

string

An opaque value used to maintain state between the request and callback.

Required string length: 1 - 4096

code_challenge

string

The PKCE code challenge derived from the code verifier.

Required string length: 43 - 128

code_challenge_method

string

The method used to derive the code challenge. Required when code_challenge is provided.

Allowed value: "S256"

scopes

string[]

Defines the permissions that the client requests from the Identity Provider. Must include the standard scopes used to identify the user (e.g. 'openid', 'email', 'profile'), the scope required to obtain refresh tokens if needed (e.g. 'offline_access'), and any custom scopes the client needs to access protected resources.

Required array length: 1 - 100 elements

Required string length: 1 - 255

例:

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

authorization_params

Authorization Parameters · object

Authorization parameters to be sent to the underlying Identity Provider (IdP) during the authorization request. These parameters influence how the IdP processes the authorization flow and what permissions are requested.

Show child attributes

レスポンス

Account connection request created successfully

connect_uri

string<uri>

必須

The base URI to initiate the account connection flow.

auth_session

string

必須

The authentication session identifier.

Maximum string length: 64

connect_params

object

必須

Parameters to be used with the connect URI.

Show child attributes

expires_in

integer

必須

The number of seconds until the ticket expires.

必須範囲: x >= 1

Factors

Authentication Methods

Connected Accounts

Create a connected account request

承認

ヘッダー

ボディ

レスポンス