EQTY LabDocs

Check user permission

Report whether the authenticated user holds the given permission and which role scope satisfied it

gethttps://localhost:8080/api/v1/rbac/check/permission/{permission}
bash
curl --request GET \
  --url 'https://localhost:8080/api/v1/rbac/check/permission/{permission}' \
  --header 'Authorization: Bearer <token>'
javascript
const response = await fetch("https://localhost:8080/api/v1/rbac/check/permission/{permission}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();
typescript
interface PermissionCheckResponse {
  context?: string;
  hasPermission?: boolean;
  permission?: string;
  projectId?: string;
  userId?: string;
}

const response = await fetch("https://localhost:8080/api/v1/rbac/check/permission/{permission}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);

const data: PermissionCheckResponse = await response.json();
python
import requests

response = requests.get(
    "https://localhost:8080/api/v1/rbac/check/permission/{permission}",
    headers={
        "Authorization": "Bearer <token>",
    },
)
response.raise_for_status()
print(response.json())
go
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://localhost:8080/api/v1/rbac/check/permission/{permission}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer <token>")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(res.Status, string(data))
}
java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://localhost:8080/api/v1/rbac/check/permission/{permission}"))
            .header("Authorization", "Bearer <token>")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}
csharp
using System.Net.Http.Headers;

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:8080/api/v1/rbac/check/permission/{permission}");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");

using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
php
<?php

$ch = curl_init('https://localhost:8080/api/v1/rbac/check/permission/{permission}');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;
ruby
require "net/http"

uri = URI("https://localhost:8080/api/v1/rbac/check/permission/{permission}")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
puts "#{response.code} #{response.body}"
rust
// Cargo.toml dependencies: reqwest, tokio (features "full")

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let response = reqwest::Client::new()
        .get("https://localhost:8080/api/v1/rbac/check/permission/{permission}")
        .header("Authorization", "Bearer <token>")
        .send()
        .await?;

    println!("{} {}", response.status(), response.text().await?);
    Ok(())
}

Authorizations

  • BearerAuth · API key in header "Authorization" — Type "Bearer" followed by a space and JWT token
  • ApiKeyAuth · API key in header "Authorization" — Type "Bearer" followed by a space and API key

Parameters

Path parameters

NameTypeDescription
permission
required
string

Permission name

Responses

200Permission check result

application/json
  • contextstring
  • hasPermissionboolean
  • permissionstring
  • projectIdstring

    The project reference as sent, or the project whose role granted the check

  • userIdstring
Examplejson
{
  "context": "organization",
  "hasPermission": true,
  "permission": "manage_org_settings",
  "projectId": "1",
  "userId": "550e8400-e29b-41d4-a716-446655440001"
}

401Unauthorized - Authentication required

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500Role lookup failed

application/json
  • errorstring
  • error_descriptionstring
Examplejson
{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}