OAuth

Preview an OAuth authorization request

Returns the client, the requested permissions with descriptions, which of them the user has not yet granted to this client for this tenant (is_new), and already_authorized when nothing new is requested. client_id may be a client ID metadata document URL: the document is fetched and validated (400 if it cannot be verified, 429 when the signed-in user fetches too many documents), verified_host is the host serving it, redirect_host is the host of the requested redirect_uri, which must be registered for the client (400 otherwise), and local_only is true when the requested redirect_uri points at this computer; already_authorized is then always false. For an application owned by a tenant, tenant_id is ignored and the preview is evaluated in that tenant; for other applications tenant_id is required (400 if missing). Returns 403 when the signed-in user cannot access the effective tenant.

GET

api

oauth

authorize

preview

Preview an OAuth authorization request

curl --request GET \
  --url https://api.costgraph.ai/api/v1/oauth/authorize/preview \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.costgraph.ai/api/v1/oauth/authorize/preview', 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.costgraph.ai/api/v1/oauth/authorize/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/oauth/authorize/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/oauth/authorize/preview")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "client": {
      "allowed_scopes": [
        "<string>"
      ],
      "client_id": "<string>",
      "client_name": "<string>",
      "client_type": "<string>",
      "created_at": "<string>",
      "redirect_uris": [
        "<string>"
      ],
      "created_by_name": "<string>",
      "homepage_url": "<string>",
      "logo_url": "<string>",
      "metadata_url": "<string>",
      "policy_url": "<string>",
      "tenant_id": "<string>",
      "tos_url": "<string>"
    },
    "redirect_host": "<string>",
    "scopes": [
      {
        "description": "<string>",
        "name": "<string>",
        "is_new": true
      }
    ],
    "already_authorized": true,
    "local_only": true,
    "verified_host": "<string>"
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Query Parameters

client_id

string

required

Client ID

redirect_uri

string

required

Redirect URI the client will return to

tenant_id

string

Tenant ID, required unless the client is owned by a tenant

scope

string

Space-separated scopes

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Preview an OAuth authorization request

curl --request GET \
  --url https://api.costgraph.ai/api/v1/oauth/authorize/preview \
  --header 'Authorization: <api-key>'

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.costgraph.ai/api/v1/oauth/authorize/preview', 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.costgraph.ai/api/v1/oauth/authorize/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/oauth/authorize/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/oauth/authorize/preview")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "client": {
      "allowed_scopes": [
        "<string>"
      ],
      "client_id": "<string>",
      "client_name": "<string>",
      "client_type": "<string>",
      "created_at": "<string>",
      "redirect_uris": [
        "<string>"
      ],
      "created_by_name": "<string>",
      "homepage_url": "<string>",
      "logo_url": "<string>",
      "metadata_url": "<string>",
      "policy_url": "<string>",
      "tenant_id": "<string>",
      "tos_url": "<string>"
    },
    "redirect_host": "<string>",
    "scopes": [
      {
        "description": "<string>",
        "name": "<string>",
        "is_new": true
      }
    ],
    "already_authorized": true,
    "local_only": true,
    "verified_host": "<string>"
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

Preview an OAuth authorization request

Authorizations

Query Parameters

Response