cURL
curl --request POST \
--url https://api.useanima.sh/v1/oauth/apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "<string>",
"name": "<string>",
"redirectUris": [
"<string>"
],
"allowedScopes": [
"<string>"
],
"description": "<string>",
"iconUrl": "<string>",
"homepageUrl": "<string>",
"privacyPolicyUrl": "<string>",
"termsOfServiceUrl": "<string>",
"ownerOrgId": "<string>"
}
'import requests
url = "https://api.useanima.sh/v1/oauth/apps"
payload = {
"clientId": "<string>",
"name": "<string>",
"redirectUris": ["<string>"],
"allowedScopes": ["<string>"],
"description": "<string>",
"iconUrl": "<string>",
"homepageUrl": "<string>",
"privacyPolicyUrl": "<string>",
"termsOfServiceUrl": "<string>",
"ownerOrgId": "<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({
clientId: '<string>',
name: '<string>',
redirectUris: ['<string>'],
allowedScopes: ['<string>'],
description: '<string>',
iconUrl: '<string>',
homepageUrl: '<string>',
privacyPolicyUrl: '<string>',
termsOfServiceUrl: '<string>',
ownerOrgId: '<string>'
})
};
fetch('https://api.useanima.sh/v1/oauth/apps', 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.useanima.sh/v1/oauth/apps",
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([
'clientId' => '<string>',
'name' => '<string>',
'redirectUris' => [
'<string>'
],
'allowedScopes' => [
'<string>'
],
'description' => '<string>',
'iconUrl' => '<string>',
'homepageUrl' => '<string>',
'privacyPolicyUrl' => '<string>',
'termsOfServiceUrl' => '<string>',
'ownerOrgId' => '<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.useanima.sh/v1/oauth/apps"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<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.useanima.sh/v1/oauth/apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/oauth/apps")
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 \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"clientId": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "VALIDATION_ERROR",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Unauthorized",
"data": "<unknown>"
}{
"defined": true,
"code": "CONFLICT",
"status": 409,
"message": "Conflict",
"data": "<unknown>"
}API Reference
Post oauthapps
POST
/
oauth
/
apps
cURL
curl --request POST \
--url https://api.useanima.sh/v1/oauth/apps \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"clientId": "<string>",
"name": "<string>",
"redirectUris": [
"<string>"
],
"allowedScopes": [
"<string>"
],
"description": "<string>",
"iconUrl": "<string>",
"homepageUrl": "<string>",
"privacyPolicyUrl": "<string>",
"termsOfServiceUrl": "<string>",
"ownerOrgId": "<string>"
}
'import requests
url = "https://api.useanima.sh/v1/oauth/apps"
payload = {
"clientId": "<string>",
"name": "<string>",
"redirectUris": ["<string>"],
"allowedScopes": ["<string>"],
"description": "<string>",
"iconUrl": "<string>",
"homepageUrl": "<string>",
"privacyPolicyUrl": "<string>",
"termsOfServiceUrl": "<string>",
"ownerOrgId": "<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({
clientId: '<string>',
name: '<string>',
redirectUris: ['<string>'],
allowedScopes: ['<string>'],
description: '<string>',
iconUrl: '<string>',
homepageUrl: '<string>',
privacyPolicyUrl: '<string>',
termsOfServiceUrl: '<string>',
ownerOrgId: '<string>'
})
};
fetch('https://api.useanima.sh/v1/oauth/apps', 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.useanima.sh/v1/oauth/apps",
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([
'clientId' => '<string>',
'name' => '<string>',
'redirectUris' => [
'<string>'
],
'allowedScopes' => [
'<string>'
],
'description' => '<string>',
'iconUrl' => '<string>',
'homepageUrl' => '<string>',
'privacyPolicyUrl' => '<string>',
'termsOfServiceUrl' => '<string>',
'ownerOrgId' => '<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.useanima.sh/v1/oauth/apps"
payload := strings.NewReader("{\n \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<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.useanima.sh/v1/oauth/apps")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/oauth/apps")
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 \"clientId\": \"<string>\",\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"allowedScopes\": [\n \"<string>\"\n ],\n \"description\": \"<string>\",\n \"iconUrl\": \"<string>\",\n \"homepageUrl\": \"<string>\",\n \"privacyPolicyUrl\": \"<string>\",\n \"termsOfServiceUrl\": \"<string>\",\n \"ownerOrgId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"clientId": "<string>",
"name": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}{
"defined": true,
"code": "VALIDATION_ERROR",
"status": 400,
"message": "VALIDATION_ERROR",
"data": "<unknown>"
}{
"defined": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "Unauthorized",
"data": "<unknown>"
}{
"defined": true,
"code": "CONFLICT",
"status": 409,
"message": "Conflict",
"data": "<unknown>"
}Authorizations
BearerAuthApiKeyAuth
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Body
application/json
Register a new third-party OAuth app
Public identifier the third-party app uses in /authorize URLs
Required string length:
3 - 64Pattern:
^[a-z0-9_-]+$Display name shown on the consent screen
Required string length:
1 - 120Exact-match URIs the consent flow will redirect to. Native CLIs use http://localhost:* or http://127.0.0.1:*.
Required array length:
1 - 20 elementsScope strings the app may request on /authorize
Minimum array length:
1Maximum string length:
500Org that registered the app — defaults to the calling master key's org
⌘I
