Ledgers

Using the ledgers command, it is possible to manage Ledgers on the remote server.

This command manages ledgers.

Usage:
  Permguard authz ledgers [flags]
  Permguard authz ledgers [command]

Available Commands:
  create      Create a ledger
  delete      Delete a ledger
  list        List ledgers
  update      Update a ledger

Flags:
      --zone-id int    zone id
  -h, --help          help for ledgers

Global Flags:
  -o, --output string   output format (default "terminal")
  -v, --verbose          true for verbose output
  -w, --workdir string   workdir (default ".")
  -v, --verbose         true for verbose output

Use "Permguard authz ledgers [command] --help" for more information about a command.

The output from your current version of Permguard may differ from the example provided on this page.

Create an Ledger

The permguard authz ledgers create command allows to create a ledger for the mandatory input zone and name.

permguard authz ledgers create --zone-id 273165098782 --name magicfarmacia

output:

668f3771eacf4094ba8a80942ea5fd3f: magicfarmacia
JSON Output
permguard authz ledgers create --zone-id 273165098782 --name magicfarmacia --output json

output:

{
  "ledgers": [
    {
      "ledger_id": "668f3771eacf4094ba8a80942ea5fd3f",
      "created_at": "2024-08-25T14:50:38.003Z",
      "updated_at": "2024-08-25T14:50:38.003Z",
      "zone_id": 273165098782,
      "name": "magicfarmacia"
    }
  ]
}

Get All Ledgers

The permguard authz ledgers list command allows for the retrieval of all ledgers.

permguard authz ledgers list --zone-id 273165098782

output:

d02af7e50a7b462cb496aa6ddeb4275e: magicfarmacia
JSON Output
permguard authz ledgers list --zone-id 273165098782 --output json

output:

{
  "ledgers": [
    {
      "ledger_id": "d02af7e50a7b462cb496aa6ddeb4275e",
      "created_at": "2024-12-25T08:49:14.467Z",
      "updated_at": "2024-12-25T08:49:14.467Z",
      "zone_id": 727373447775,
      "name": "727373447775",
      "kind": "policy",
      "ref": "0000000000000000000000000000000000000000000000000000000000000000"
    }
  ]
}