OAuth Server Config API
Create or update OAuth server config
Enable and configure your application as an OAuth 2.0 authorization
server. The presence of the registration.dcr and
registration.cimd objects enables Dynamic Client Registration
(RFC 7591) and Client ID Metadata Documents respectively; omit one to
leave that mechanism disabled.
PUT
/
v2
/
session
/
apps
/
{appID}
/
oauth
Create or update OAuth server config
curl --request PUT \
--url https://api.prelude.dev/v2/session/apps/{appID}/oauth \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": [
"https://claude.ai/api/mcp/auth_callback",
"http://localhost/*"
],
"dcr": {
"default_scopes": [
"mcp:read"
],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": [
"https://claude.ai/*"
],
"default_scopes": [
"mcp:read"
],
"cache_ttl_seconds": 86400
}
}
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/oauth"
payload = {
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": ["https://claude.ai/api/mcp/auth_callback", "http://localhost/*"],
"dcr": {
"default_scopes": ["mcp:read"],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": ["https://claude.ai/*"],
"default_scopes": ["mcp:read"],
"cache_ttl_seconds": 86400
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
default_provider_url: 'https://auth.example.com',
registration: {
redirect_uri_allowlist: ['https://claude.ai/api/mcp/auth_callback', 'http://localhost/*'],
dcr: {default_scopes: ['mcp:read'], auto_registered_client_ttl_seconds: 2592000},
cimd: {
client_url_allowlist: ['https://claude.ai/*'],
default_scopes: ['mcp:read'],
cache_ttl_seconds: 86400
}
}
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/oauth', 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.prelude.dev/v2/session/apps/{appID}/oauth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'default_provider_url' => 'https://auth.example.com',
'registration' => [
'redirect_uri_allowlist' => [
'https://claude.ai/api/mcp/auth_callback',
'http://localhost/*'
],
'dcr' => [
'default_scopes' => [
'mcp:read'
],
'auto_registered_client_ttl_seconds' => 2592000
],
'cimd' => [
'client_url_allowlist' => [
'https://claude.ai/*'
],
'default_scopes' => [
'mcp:read'
],
'cache_ttl_seconds' => 86400
]
]
]),
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://api.prelude.dev/v2/session/apps/{appID}/oauth"
payload := strings.NewReader("{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.prelude.dev/v2/session/apps/{appID}/oauth")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/oauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": [
"https://claude.ai/api/mcp/auth_callback",
"http://localhost/*"
],
"dcr": {
"default_scopes": [
"mcp:read"
],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": [
"https://claude.ai/*"
],
"default_scopes": [
"mcp:read"
],
"cache_ttl_seconds": 86400
}
},
"updated_at": 1718000000
}{
"code": "invalid_oauth_server_config",
"status": "bad_request",
"message": "default_provider_url must be an absolute http(s) URL with a host"
}{
"code": "app_not_found",
"status": "not_found",
"message": "The application was not found."
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the app the request refers to. An application's unique identifier.
Examples:
"54e9ujn"
"fvua38g"
Body
application/json
Origin of your login UI. The server redirects the browser to <default_provider_url>/sign-in from /authorize and to <default_provider_url>/oauth/consent after login. Must be an absolute http(s) URL.
Example:
"https://auth.example.com"
How third-party clients come to exist, and the settings they share.
Show child attributes
Show child attributes
⌘I
Create or update OAuth server config
curl --request PUT \
--url https://api.prelude.dev/v2/session/apps/{appID}/oauth \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": [
"https://claude.ai/api/mcp/auth_callback",
"http://localhost/*"
],
"dcr": {
"default_scopes": [
"mcp:read"
],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": [
"https://claude.ai/*"
],
"default_scopes": [
"mcp:read"
],
"cache_ttl_seconds": 86400
}
}
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/oauth"
payload = {
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": ["https://claude.ai/api/mcp/auth_callback", "http://localhost/*"],
"dcr": {
"default_scopes": ["mcp:read"],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": ["https://claude.ai/*"],
"default_scopes": ["mcp:read"],
"cache_ttl_seconds": 86400
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
default_provider_url: 'https://auth.example.com',
registration: {
redirect_uri_allowlist: ['https://claude.ai/api/mcp/auth_callback', 'http://localhost/*'],
dcr: {default_scopes: ['mcp:read'], auto_registered_client_ttl_seconds: 2592000},
cimd: {
client_url_allowlist: ['https://claude.ai/*'],
default_scopes: ['mcp:read'],
cache_ttl_seconds: 86400
}
}
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/oauth', 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.prelude.dev/v2/session/apps/{appID}/oauth",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'default_provider_url' => 'https://auth.example.com',
'registration' => [
'redirect_uri_allowlist' => [
'https://claude.ai/api/mcp/auth_callback',
'http://localhost/*'
],
'dcr' => [
'default_scopes' => [
'mcp:read'
],
'auto_registered_client_ttl_seconds' => 2592000
],
'cimd' => [
'client_url_allowlist' => [
'https://claude.ai/*'
],
'default_scopes' => [
'mcp:read'
],
'cache_ttl_seconds' => 86400
]
]
]),
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://api.prelude.dev/v2/session/apps/{appID}/oauth"
payload := strings.NewReader("{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.prelude.dev/v2/session/apps/{appID}/oauth")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/oauth")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"default_provider_url\": \"https://auth.example.com\",\n \"registration\": {\n \"redirect_uri_allowlist\": [\n \"https://claude.ai/api/mcp/auth_callback\",\n \"http://localhost/*\"\n ],\n \"dcr\": {\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"auto_registered_client_ttl_seconds\": 2592000\n },\n \"cimd\": {\n \"client_url_allowlist\": [\n \"https://claude.ai/*\"\n ],\n \"default_scopes\": [\n \"mcp:read\"\n ],\n \"cache_ttl_seconds\": 86400\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"default_provider_url": "https://auth.example.com",
"registration": {
"redirect_uri_allowlist": [
"https://claude.ai/api/mcp/auth_callback",
"http://localhost/*"
],
"dcr": {
"default_scopes": [
"mcp:read"
],
"auto_registered_client_ttl_seconds": 2592000
},
"cimd": {
"client_url_allowlist": [
"https://claude.ai/*"
],
"default_scopes": [
"mcp:read"
],
"cache_ttl_seconds": 86400
}
},
"updated_at": 1718000000
}{
"code": "invalid_oauth_server_config",
"status": "bad_request",
"message": "default_provider_url must be an absolute http(s) URL with a host"
}{
"code": "app_not_found",
"status": "not_found",
"message": "The application was not found."
}