curl --request POST \
--url https://api.hq.zone/v1/oauth/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "<string>",
"grant_types": [
"<string>"
],
"redirect_uris": [
"<string>"
],
"response_types": [
"<string>"
],
"scope": "<string>",
"token_endpoint_auth_method": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/oauth/register"
payload = {
"client_name": "<string>",
"grant_types": ["<string>"],
"redirect_uris": ["<string>"],
"response_types": ["<string>"],
"scope": "<string>",
"token_endpoint_auth_method": "<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>',
grant_types: ['<string>'],
redirect_uris: ['<string>'],
response_types: ['<string>'],
scope: '<string>',
token_endpoint_auth_method: '<string>'
})
};
fetch('https://api.hq.zone/v1/oauth/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://api.hq.zone/v1/oauth/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' => '<string>',
'grant_types' => [
'<string>'
],
'redirect_uris' => [
'<string>'
],
'response_types' => [
'<string>'
],
'scope' => '<string>',
'token_endpoint_auth_method' => '<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.hq.zone/v1/oauth/register"
payload := strings.NewReader("{\n \"client_name\": \"<string>\",\n \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\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.hq.zone/v1/oauth/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"<string>\",\n \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/oauth/register")
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 \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"client_id_issued_at": 123,
"client_name": "<string>",
"grant_types": [
"<string>"
],
"redirect_uris": [
"<string>"
],
"registration_client_uri": "<string>",
"response_types": [
"<string>"
],
"scope": "<string>",
"token_endpoint_auth_method": "<string>",
"client_secret": "<string>",
"client_secret_expires_at": 123,
"registration_access_token": "<string>"
}Register an OAuth client
OAuth 2.1 Dynamic Client Registration (RFC 7591). Registration is authenticated: the caller must present a valid HQ session or token, and the resulting client is owned by that user. Validates the submitted JSON metadata (redirect URIs must be https or http loopback with no fragment; scopes must be known capability scopes; token_endpoint_auth_method none yields a public client, client_secret_post/basic a confidential one). Returns 201 with the new client_id, a registration_access_token, and, for confidential clients, a client_secret (the secret and registration token are shown only once), plus a registration_client_uri for managing the client. Registered clients are always treated as third-party and shown the consent screen, and each account is capped on how many it may register.
curl --request POST \
--url https://api.hq.zone/v1/oauth/register \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_name": "<string>",
"grant_types": [
"<string>"
],
"redirect_uris": [
"<string>"
],
"response_types": [
"<string>"
],
"scope": "<string>",
"token_endpoint_auth_method": "<string>"
}
'import requests
url = "https://api.hq.zone/v1/oauth/register"
payload = {
"client_name": "<string>",
"grant_types": ["<string>"],
"redirect_uris": ["<string>"],
"response_types": ["<string>"],
"scope": "<string>",
"token_endpoint_auth_method": "<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>',
grant_types: ['<string>'],
redirect_uris: ['<string>'],
response_types: ['<string>'],
scope: '<string>',
token_endpoint_auth_method: '<string>'
})
};
fetch('https://api.hq.zone/v1/oauth/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://api.hq.zone/v1/oauth/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' => '<string>',
'grant_types' => [
'<string>'
],
'redirect_uris' => [
'<string>'
],
'response_types' => [
'<string>'
],
'scope' => '<string>',
'token_endpoint_auth_method' => '<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.hq.zone/v1/oauth/register"
payload := strings.NewReader("{\n \"client_name\": \"<string>\",\n \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\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.hq.zone/v1/oauth/register")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_name\": \"<string>\",\n \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/oauth/register")
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 \"grant_types\": [\n \"<string>\"\n ],\n \"redirect_uris\": [\n \"<string>\"\n ],\n \"response_types\": [\n \"<string>\"\n ],\n \"scope\": \"<string>\",\n \"token_endpoint_auth_method\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"client_id_issued_at": 123,
"client_name": "<string>",
"grant_types": [
"<string>"
],
"redirect_uris": [
"<string>"
],
"registration_client_uri": "<string>",
"response_types": [
"<string>"
],
"scope": "<string>",
"token_endpoint_auth_method": "<string>",
"client_secret": "<string>",
"client_secret_expires_at": 123,
"registration_access_token": "<string>"
}Dynamic client registration (RFC 7591)
Registers a new OAuth client and returns itsclient_id and registration metadata. Public clients (e.g. browser apps) use PKCE and have no secret. Provide your redirect_uris and the scopes the client may request. Afterwards, manage the registration with Get / Update / Delete using the returned credentials.Authorizations
Personal Access Token. Send as Authorization: Bearer hq_pat_....
Body
Response
Registered client (client_id + one-time secret/registration token), RFC 7591