Skip to main content
POST
/
oauth
Create credentials
curl --request POST \
  --url https://api.example.com/oauth \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "handle": "<string>",
  "_auth": {
    "owner": "<string>",
    "realm": "<string>",
    "organization": "<string>",
    "domain": "<string>"
  },
  "scopes": [
    "<string>"
  ],
  "roles": [
    "<string>"
  ]
}
'
import requests

url = "https://api.example.com/oauth"

payload = {
"handle": "<string>",
"_auth": {
"owner": "<string>",
"realm": "<string>",
"organization": "<string>",
"domain": "<string>"
},
"scopes": ["<string>"],
"roles": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
handle: '<string>',
_auth: {
owner: '<string>',
realm: '<string>',
organization: '<string>',
domain: '<string>'
},
scopes: ['<string>'],
roles: ['<string>']
})
};

fetch('https://api.example.com/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.example.com/oauth",
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([
'handle' => '<string>',
'_auth' => [
'owner' => '<string>',
'realm' => '<string>',
'organization' => '<string>',
'domain' => '<string>'
],
'scopes' => [
'<string>'
],
'roles' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$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/oauth"

payload := strings.NewReader("{\n \"handle\": \"<string>\",\n \"_auth\": {\n \"owner\": \"<string>\",\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"domain\": \"<string>\"\n },\n \"scopes\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
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/oauth")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"handle\": \"<string>\",\n \"_auth\": {\n \"owner\": \"<string>\",\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"domain\": \"<string>\"\n },\n \"scopes\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/oauth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"handle\": \"<string>\",\n \"_auth\": {\n \"owner\": \"<string>\",\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"domain\": \"<string>\"\n },\n \"scopes\": [\n \"<string>\"\n ],\n \"roles\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "handle": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "api_key": "<string>",
  "_auth": {
    "owner": "<string>",
    "realm": "<string>",
    "organization": "<string>",
    "domain": "<string>"
  },
  "scopes": [
    "<string>"
  ],
  "roles": [
    "<string>"
  ],
  "created": "<string>",
  "updated": "<string>"
}
{
"error": {
"code": 123,
"message": "<string>",
"details": {}
}
}
{
"code": 123,
"message": "<string>",
"details": {}
}

Authorizations

x-api-key
string
header
required

Body

application/json
handle
string
_auth
object
scopes
string[]
roles
string[]

Response

Credentials created successfully

handle
string
client_id
string
client_secret
string
api_key
string
_auth
object
scopes
string[]
roles
string[]
created
string
updated
string