Users

Get current user

Returns the full user profile for BearerAuth, including the caller’s organization role and read_only, which is true for a staff support session that may only read. When authenticated with ApiKeyAuth, the response data is user.CurrentAPIKeyResponse and includes subject_type, auth_method, tenants, the organization, and permission_scopes, the effective scopes the key is granted. oauth_scopes lists the permissions of the application token, present only when called with one. tenants lists every tenant the user belongs to, also when called with an application token; such a token can still only access the tenant it was approved for, so use tenants to offer a switch, not as the set the token can read.

GET

api

Get current user

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

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

fetch('https://api.costgraph.ai/api/v1/me', 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/me",
  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/me"

	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/me")

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": {
    "auth_method": "<string>",
    "role": "<string>",
    "subject_type": "<string>",
    "tenants": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "deployment": {
      "license_state": "<string>",
      "mode": "<string>",
      "read_only": true
    },
    "email": "<string>",
    "name": "<string>",
    "oauth_scopes": [
      "<string>"
    ],
    "organization_id": "<string>",
    "organization_name": "<string>",
    "organization_slug": "<string>",
    "posthog": {
      "distinct_id": "<string>",
      "identity_hash": "<string>"
    },
    "read_only": true,
    "user_id": "<string>"
  }
}

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

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

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

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Response

BearerAuth response; ApiKeyAuth response data is user.CurrentAPIKeyResponse

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Get current user

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

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

fetch('https://api.costgraph.ai/api/v1/me', 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/me",
  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/me"

	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/me")

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": {
    "auth_method": "<string>",
    "role": "<string>",
    "subject_type": "<string>",
    "tenants": [
      {
        "id": "<string>",
        "name": "<string>"
      }
    ],
    "deployment": {
      "license_state": "<string>",
      "mode": "<string>",
      "read_only": true
    },
    "email": "<string>",
    "name": "<string>",
    "oauth_scopes": [
      "<string>"
    ],
    "organization_id": "<string>",
    "organization_name": "<string>",
    "organization_slug": "<string>",
    "posthog": {
      "distinct_id": "<string>",
      "identity_hash": "<string>"
    },
    "read_only": true,
    "user_id": "<string>"
  }
}

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

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

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

Getting started

Endpoints

Get current user

Authorizations

Response