OAuth Server Config API
Register OAuth client
Pre-register an OAuth client for a known integration, as an
alternative to Dynamic Client Registration or Client ID Metadata
Documents. A manually-registered client must carry its own
provider_url — it does not inherit the app’s default_provider_url.
POST
/
v2
/
session
/
apps
/
{appID}
/
oauth
/
clients
Register OAuth client
curl --request POST \
--url https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "<string>",
"redirect_uris": [
"<string>"
],
"provider_url": "<string>",
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients"
payload = {
"client_name": "<string>",
"redirect_uris": ["<string>"],
"provider_url": "<string>",
"scopes": ["<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({
client_name: '<string>',
redirect_uris: ['<string>'],
provider_url: '<string>',
scopes: ['<string>']
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients', 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/clients",
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([
'client_name' => '<string>',
'redirect_uris' => [
'<string>'
],
'provider_url' => '<string>',
'scopes' => [
'<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://api.prelude.dev/v2/session/apps/{appID}/oauth/clients"
payload := strings.NewReader("{\n \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<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://api.prelude.dev/v2/session/apps/{appID}/oauth/clients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients")
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 \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"client": {
"client_id": "<string>",
"app_id": "<string>",
"client_name": "<string>",
"redirect_uris": [
"<string>"
],
"created_at": 123,
"scopes": [
"<string>"
],
"provider_url": "<string>"
}
}{
"code": "invalid_oauth_client",
"status": "bad_request",
"message": "<string>"
}{
"code": "app_not_found",
"status": "not_found",
"message": "<string>"
}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
Human-readable name shown on the consent screen.
Example:
"Internal MCP client"
Allowed redirect URIs for this client.
Example:
["https://mcp.example.com/oauth/callback"]
Login UI origin for this client. Manually-registered clients do not inherit default_provider_url and must set their own.
Example:
"https://auth.example.com"
Scopes granted to this client.
Example:
["mcp:read", "mcp:write"]
Response
Created
Show child attributes
Show child attributes
⌘I
Register OAuth client
curl --request POST \
--url https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "<string>",
"redirect_uris": [
"<string>"
],
"provider_url": "<string>",
"scopes": [
"<string>"
]
}
'import requests
url = "https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients"
payload = {
"client_name": "<string>",
"redirect_uris": ["<string>"],
"provider_url": "<string>",
"scopes": ["<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({
client_name: '<string>',
redirect_uris: ['<string>'],
provider_url: '<string>',
scopes: ['<string>']
})
};
fetch('https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients', 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/clients",
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([
'client_name' => '<string>',
'redirect_uris' => [
'<string>'
],
'provider_url' => '<string>',
'scopes' => [
'<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://api.prelude.dev/v2/session/apps/{appID}/oauth/clients"
payload := strings.NewReader("{\n \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<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://api.prelude.dev/v2/session/apps/{appID}/oauth/clients")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prelude.dev/v2/session/apps/{appID}/oauth/clients")
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 \"client_name\": \"<string>\",\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"provider_url\": \"<string>\",\n \"scopes\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"client": {
"client_id": "<string>",
"app_id": "<string>",
"client_name": "<string>",
"redirect_uris": [
"<string>"
],
"created_at": 123,
"scopes": [
"<string>"
],
"provider_url": "<string>"
}
}{
"code": "invalid_oauth_client",
"status": "bad_request",
"message": "<string>"
}{
"code": "app_not_found",
"status": "not_found",
"message": "<string>"
}