Authenticate

Get OAuth token or start authentication flow if needed.

POST /v2/auth/authenticate

Authenticate

cURL

curl --request POST \
  --url https://api.example.com/v2/auth/authenticate \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "scopes": [
    "<string>"
  ],
  "user_id": "<string>",
  "ls_user_id": "<string>",
  "agent_id": "<string>",
  "use_agent_builder_public_oauth": false,
  "force_new": false,
  "token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "redirect_uri": "<string>",
  "is_default": true,
  "check_only": false
}
'

import requests

url = "https://api.example.com/v2/auth/authenticate"

payload = {
    "provider": "<string>",
    "scopes": ["<string>"],
    "user_id": "<string>",
    "ls_user_id": "<string>",
    "agent_id": "<string>",
    "use_agent_builder_public_oauth": False,
    "force_new": False,
    "token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "redirect_uri": "<string>",
    "is_default": True,
    "check_only": False
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    provider: '<string>',
    scopes: ['<string>'],
    user_id: '<string>',
    ls_user_id: '<string>',
    agent_id: '<string>',
    use_agent_builder_public_oauth: false,
    force_new: false,
    token_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    redirect_uri: '<string>',
    is_default: true,
    check_only: false
  })
};

fetch('https://api.example.com/v2/auth/authenticate', 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://api.example.com/v2/auth/authenticate",
  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([
    'provider' => '<string>',
    'scopes' => [
        '<string>'
    ],
    'user_id' => '<string>',
    'ls_user_id' => '<string>',
    'agent_id' => '<string>',
    'use_agent_builder_public_oauth' => false,
    'force_new' => false,
    'token_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'redirect_uri' => '<string>',
    'is_default' => true,
    'check_only' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/v2/auth/authenticate"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"ls_user_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"use_agent_builder_public_oauth\": false,\n  \"force_new\": false,\n  \"token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"redirect_uri\": \"<string>\",\n  \"is_default\": true,\n  \"check_only\": false\n}")

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

	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://api.example.com/v2/auth/authenticate")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"ls_user_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"use_agent_builder_public_oauth\": false,\n  \"force_new\": false,\n  \"token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"redirect_uri\": \"<string>\",\n  \"is_default\": true,\n  \"check_only\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/auth/authenticate")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\",\n  \"scopes\": [\n    \"<string>\"\n  ],\n  \"user_id\": \"<string>\",\n  \"ls_user_id\": \"<string>\",\n  \"agent_id\": \"<string>\",\n  \"use_agent_builder_public_oauth\": false,\n  \"force_new\": false,\n  \"token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"redirect_uri\": \"<string>\",\n  \"is_default\": true,\n  \"check_only\": false\n}"

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

200

{
  "url": "<string>",
  "auth_id": "<string>",
  "token": "<string>",
  "user_id": "<string>",
  "metadata": {}
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Auth authenticate request.

provider · string · required

scopes · string[] · required

user_id · string | null

ls_user_id · string | null

agent_id · string | null

use_agent_builder_public_oauth · boolean · default: false

force_new · boolean · default: false

token_id · string<uuid> | null

redirect_uri · string | null

is_default · boolean · default: true

check_only · boolean · default: false

Response

200

application/json

Successful Response

Auth authenticate response.

status · enum<string> · required

Valid authentication status values.

Available options: completed, pending, connection_required, token_expired

url · string | null

auth_id · string | null

token · string | null

user_id · string | null

metadata · Metadata · object | null