Create Oauth Provider

Create a new OAuth provider manually.

POST /v2/auth/providers

Create Oauth Provider

cURL

curl --request POST \
  --url https://api.example.com/v2/auth/providers \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider_id": "<string>",
  "name": "<string>",
  "client_id": "<string>",
  "auth_url": "<string>",
  "token_url": "<string>",
  "client_secret": "<string>",
  "uses_pkce": false,
  "code_challenge_method": "S256",
  "token_endpoint_auth_method": "client_secret_post",
  "authorization_params": {},
  "allowed_redirect_uris": [
    "<string>"
  ],
  "default_redirect_uri": "<string>"
}
'

import requests

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

payload = {
    "provider_id": "<string>",
    "name": "<string>",
    "client_id": "<string>",
    "auth_url": "<string>",
    "token_url": "<string>",
    "client_secret": "<string>",
    "uses_pkce": False,
    "code_challenge_method": "S256",
    "token_endpoint_auth_method": "client_secret_post",
    "authorization_params": {},
    "allowed_redirect_uris": ["<string>"],
    "default_redirect_uri": "<string>"
}
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_id: '<string>',
    name: '<string>',
    client_id: '<string>',
    auth_url: '<string>',
    token_url: '<string>',
    client_secret: '<string>',
    uses_pkce: false,
    code_challenge_method: 'S256',
    token_endpoint_auth_method: 'client_secret_post',
    authorization_params: {},
    allowed_redirect_uris: ['<string>'],
    default_redirect_uri: '<string>'
  })
};

fetch('https://api.example.com/v2/auth/providers', 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/providers",
  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_id' => '<string>',
    'name' => '<string>',
    'client_id' => '<string>',
    'auth_url' => '<string>',
    'token_url' => '<string>',
    'client_secret' => '<string>',
    'uses_pkce' => false,
    'code_challenge_method' => 'S256',
    'token_endpoint_auth_method' => 'client_secret_post',
    'authorization_params' => [
        
    ],
    'allowed_redirect_uris' => [
        '<string>'
    ],
    'default_redirect_uri' => '<string>'
  ]),
  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/providers"

	payload := strings.NewReader("{\n  \"provider_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"auth_url\": \"<string>\",\n  \"token_url\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"uses_pkce\": false,\n  \"code_challenge_method\": \"S256\",\n  \"token_endpoint_auth_method\": \"client_secret_post\",\n  \"authorization_params\": {},\n  \"allowed_redirect_uris\": [\n    \"<string>\"\n  ],\n  \"default_redirect_uri\": \"<string>\"\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/providers")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"auth_url\": \"<string>\",\n  \"token_url\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"uses_pkce\": false,\n  \"code_challenge_method\": \"S256\",\n  \"token_endpoint_auth_method\": \"client_secret_post\",\n  \"authorization_params\": {},\n  \"allowed_redirect_uris\": [\n    \"<string>\"\n  ],\n  \"default_redirect_uri\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_id\": \"<string>\",\n  \"name\": \"<string>\",\n  \"client_id\": \"<string>\",\n  \"auth_url\": \"<string>\",\n  \"token_url\": \"<string>\",\n  \"client_secret\": \"<string>\",\n  \"uses_pkce\": false,\n  \"code_challenge_method\": \"S256\",\n  \"token_endpoint_auth_method\": \"client_secret_post\",\n  \"authorization_params\": {},\n  \"allowed_redirect_uris\": [\n    \"<string>\"\n  ],\n  \"default_redirect_uri\": \"<string>\"\n}"

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

200

{
  "id": "<string>",
  "organization_id": "<string>",
  "provider_id": "<string>",
  "name": "<string>",
  "client_id": "<string>",
  "auth_url": "<string>",
  "token_url": "<string>",
  "uses_pkce": true,
  "code_challenge_method": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "provider_type": "<string>",
  "mcp_server_url": "<string>",
  "token_endpoint_auth_method": "client_secret_post",
  "authorization_params": {},
  "is_dynamic_client": false,
  "allowed_redirect_uris": [
    "<string>"
  ],
  "default_redirect_uri": "<string>"
}

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

Body

application/json

Request model for creating OAuth provider manually.

provider_id · string · required

name · string · required

client_id · string · required

auth_url · string · required

token_url · string · required

client_secret · string | null

uses_pkce · boolean · default: false

code_challenge_method · string · default: S256

provider_type · enum<string> | null

Available options: microsoft, salesforce, slack, x

token_endpoint_auth_method · enum<string> · default: client_secret_post

Available options: none, client_secret_basic, client_secret_post

authorization_params · Authorization Params · object

Show child attributes

allowed_redirect_uris · string[]

default_redirect_uri · string | null

Response

200

application/json

Successful Response

Response model for OAuth provider.

id · string · required

organization_id · string · required

provider_id · string · required

name · string · required

client_id · string · required

auth_url · string · required

token_url · string · required

uses_pkce · boolean · required

code_challenge_method · string | null · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

provider_type · string | null

mcp_server_url · string | null

token_endpoint_auth_method · string · default: client_secret_post

authorization_params · Authorization Params · object

Show child attributes

is_dynamic_client · boolean · default: false

allowed_redirect_uris · string[]

default_redirect_uri · string | null