Register a client
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/register \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "Acme Analytics",
"redirect_uris": [
"https://acme.example.com/oauth/callback"
],
"grant_types": [
"authorization_code",
"refresh_token"
],
"scope": "campaigns:read contracts:read offline_access",
"token_endpoint_auth_method": "none"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/register"
payload = {
"client_name": "Acme Analytics",
"redirect_uris": ["https://acme.example.com/oauth/callback"],
"grant_types": ["authorization_code", "refresh_token"],
"scope": "campaigns:read contracts:read offline_access",
"token_endpoint_auth_method": "none"
}
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({
client_name: 'Acme Analytics',
redirect_uris: ['https://acme.example.com/oauth/callback'],
grant_types: ['authorization_code', 'refresh_token'],
scope: 'campaigns:read contracts:read offline_access',
token_endpoint_auth_method: 'none'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/register', 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://app.sideshift.app/api/oauth/v1/register",
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' => 'Acme Analytics',
'redirect_uris' => [
'https://acme.example.com/oauth/callback'
],
'grant_types' => [
'authorization_code',
'refresh_token'
],
'scope' => 'campaigns:read contracts:read offline_access',
'token_endpoint_auth_method' => 'none'
]),
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://app.sideshift.app/api/oauth/v1/register"
payload := strings.NewReader("{\n \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\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://app.sideshift.app/api/oauth/v1/register")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/register")
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 \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\n}"
response = http.request(request)
puts response.read_body{
"client_id": "oauthc_8f1c2e...",
"client_id_issued_at": 1718700000,
"registration_access_token": "rat_9a8b7c...",
"registration_client_uri": "https://app.sideshift.app/api/oauth/v1/clients/oauthc_8f1c2e...",
"redirect_uris": [
"https://acme.example.com/oauth/callback"
],
"grant_types": [
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"token_endpoint_auth_method": "none",
"scope": "campaigns:read contracts:read offline_access",
"client_name": "Acme Analytics"
}{
"error": "invalid_grant",
"error_description": "Authorization code is invalid or expired"
}{
"error": "temporarily_unavailable",
"error_description": "Rate limit exceeded"
}Register a client
Dynamic Client Registration (RFC 7591). Open, per-IP rate-limited. Returns the client_id, a one-time registration_access_token (for RFC 7592 management), and — for confidential clients — a one-time client_secret. The client starts pending and activates on first consent by a SideShift company. Subscription eligibility is enforced when the issued token calls a resource.
POST
/
register
Register a client
curl --request POST \
--url https://app.sideshift.app/api/oauth/v1/register \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "Acme Analytics",
"redirect_uris": [
"https://acme.example.com/oauth/callback"
],
"grant_types": [
"authorization_code",
"refresh_token"
],
"scope": "campaigns:read contracts:read offline_access",
"token_endpoint_auth_method": "none"
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/register"
payload = {
"client_name": "Acme Analytics",
"redirect_uris": ["https://acme.example.com/oauth/callback"],
"grant_types": ["authorization_code", "refresh_token"],
"scope": "campaigns:read contracts:read offline_access",
"token_endpoint_auth_method": "none"
}
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({
client_name: 'Acme Analytics',
redirect_uris: ['https://acme.example.com/oauth/callback'],
grant_types: ['authorization_code', 'refresh_token'],
scope: 'campaigns:read contracts:read offline_access',
token_endpoint_auth_method: 'none'
})
};
fetch('https://app.sideshift.app/api/oauth/v1/register', 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://app.sideshift.app/api/oauth/v1/register",
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' => 'Acme Analytics',
'redirect_uris' => [
'https://acme.example.com/oauth/callback'
],
'grant_types' => [
'authorization_code',
'refresh_token'
],
'scope' => 'campaigns:read contracts:read offline_access',
'token_endpoint_auth_method' => 'none'
]),
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://app.sideshift.app/api/oauth/v1/register"
payload := strings.NewReader("{\n \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\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://app.sideshift.app/api/oauth/v1/register")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/register")
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 \"client_name\": \"Acme Analytics\",\n \"redirect_uris\": [\n \"https://acme.example.com/oauth/callback\"\n ],\n \"grant_types\": [\n \"authorization_code\",\n \"refresh_token\"\n ],\n \"scope\": \"campaigns:read contracts:read offline_access\",\n \"token_endpoint_auth_method\": \"none\"\n}"
response = http.request(request)
puts response.read_body{
"client_id": "oauthc_8f1c2e...",
"client_id_issued_at": 1718700000,
"registration_access_token": "rat_9a8b7c...",
"registration_client_uri": "https://app.sideshift.app/api/oauth/v1/clients/oauthc_8f1c2e...",
"redirect_uris": [
"https://acme.example.com/oauth/callback"
],
"grant_types": [
"authorization_code",
"refresh_token"
],
"response_types": [
"code"
],
"token_endpoint_auth_method": "none",
"scope": "campaigns:read contracts:read offline_access",
"client_name": "Acme Analytics"
}{
"error": "invalid_grant",
"error_description": "Authorization code is invalid or expired"
}{
"error": "temporarily_unavailable",
"error_description": "Rate limit exceeded"
}Body
application/json
RFC 7591 client metadata. All fields optional except redirect_uris for authorization-code clients.
Absolute HTTPS URIs (loopback HTTP allowed); no fragments.
Available options:
authorization_code, refresh_token, client_credentials Available options:
code Space-delimited capability scopes (whitelist-validated).
Available options:
none, client_secret_basic, client_secret_post Response
Client registered.
RFC 7591/7592 client information response.
Returned only on registration.
Confidential clients only; returned once at registration.
⌘I