OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
POST/v1/auth/grants

Create an authorization grant

operation ID: post_v1_auth_grants

Overview

Create an authorization grant. 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 create an authorization grant.
  • 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

curl --request POST \
  --url "$ORDINATE_URL/v1/auth/grants" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "principal": "string",
    "role_id": "00000000-0000-4000-8000-000000000001",
    "scope_kind": "site",
    "scope_id": "00000000-0000-4000-8000-000000000001"
  }'

Expected output · 201

Grant created

Example 201 output

{
  "grant_id": "00000000-0000-4000-8000-000000000001",
  "principal": "string",
  "role_id": "00000000-0000-4000-8000-000000000001",
  "scope_kind": "site",
  "scope_id": "00000000-0000-4000-8000-000000000001",
  "valid_from_ns": 0,
  "valid_to_ns": 0,
  "tx_id": 0
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to create an authorization grant. The documented 201 response is grant created.

How it works

OrdinateDB resolves a session or bearer credential to a principal, then evaluates roles, capabilities, and resource scope for each protected operation.

Reference

Required capability
admin
Authorization scope
handler-resolved target

Parameters

No parameters.

Request body

application/json

principalPrincipalStringrequired
PrincipalString
string

Grant-subject grammar: system, user UUID, service UUID, or an IdP group name.

pattern: ^(system|(user|svc):[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|group:.+)$
role_idstringrequired
format: uuid
scope_idstringrequired
format: uuid
scope_kindstringrequired
unknown fields rejected

Example request body

{
  "principal": "string",
  "role_id": "00000000-0000-4000-8000-000000000001",
  "scope_kind": "site",
  "scope_id": "00000000-0000-4000-8000-000000000001"
}

Responses

201Grant created

application/json

grant_idstringrequired
format: uuid
principalPrincipalStringrequired
PrincipalString
string

Grant-subject grammar: system, user UUID, service UUID, or an IdP group name.

pattern: ^(system|(user|svc):[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}|group:.+)$
role_idstringrequired
format: uuid
scope_idstringrequired
format: uuid
scope_kindstringrequired
tx_idintegerrequired
format: int64
valid_from_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
valid_to_nsany ofrequired

any of

option 1

integer

UTC Unix timestamp in nanoseconds

format: int64

option 2

null
unknown fields rejected

Example 201 output

{
  "grant_id": "00000000-0000-4000-8000-000000000001",
  "principal": "string",
  "role_id": "00000000-0000-4000-8000-000000000001",
  "scope_kind": "site",
  "scope_id": "00000000-0000-4000-8000-000000000001",
  "valid_from_ns": 0,
  "valid_to_ns": 0,
  "tx_id": 0
}
400Invalid grant

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 400 output

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

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 401 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
403Required capability is not granted

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 403 output

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

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 409 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
503Model database is not configured

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 503 output

{
  "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.

JavaScript

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

const response = await fetch(`${ordinateUrl}/v1/auth/grants`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "principal": "string",
  "role_id": "00000000-0000-4000-8000-000000000001",
  "scope_kind": "site",
  "scope_id": "00000000-0000-4000-8000-000000000001"
})
});

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

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

Related topics