List authorization roles

Overview

List authorization roles. The authentication API establishes identity and manages the roles, grants, sessions, and service credentials used for authorization.

When to use it

• Use it when an application needs to list authorization roles.
• Use it when a client needs to sign in, inspect its identity, or an administrator needs to manage access.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/auth/roles" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "entries": [
    {
      "role_id": "00000000-0000-4000-8000-000000000001",
      "name": "string",
      "capabilities": [
        "read"
      ],
      "system": false,
      "valid_from_ns": 0,
      "valid_to_ns": 0,
      "tx_id": 0
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to list authorization roles. The documented 200 response is roles.

How it works

Reference

Required capability

admin

Authorization scope

handler-resolved target

{
  "entries": [
    {
      "role_id": "00000000-0000-4000-8000-000000000001",
      "name": "string",
      "capabilities": [
        "read"
      ],
      "system": false,
      "valid_from_ns": 0,
      "valid_to_ns": 0,
      "tx_id": 0
    }
  ]
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/auth/roles`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);