Ledgers

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

 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")
      --spiffe-enabled           enable native SPIFFE mTLS via Workload API
      --spiffe-endpoint string   SPIFFE Workload API socket path (defaults to SPIFFE_ENDPOINT_SOCKET env)
      --tls-ca-file string       path to CA certificate for server verification (PEM)
      --tls-cert-file string     path to client certificate for mTLS (PEM)
      --tls-key-file string      path to client private key for mTLS (PEM)
      --tls-skip-verify          skip server certificate verification (insecure, dev only)
  -v, --verbose                  true for verbose output
  -w, --workdir string           workdir (default ".")

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

caution

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

Create a 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 root

output:

668f3771eacf4094ba8a80942ea5fd3f: root

JSON Output

permguard authz ledgers create --zone-id 273165098782 root --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": "root"
    }
  ]
}

Update a Ledger

The permguard authz ledgers update command allows to update the name of an existing ledger.

permguard authz ledgers update --zone-id 273165098782 --ledger-id 668f3771eacf4094ba8a80942ea5fd3f v1.1

output:

668f3771eacf4094ba8a80942ea5fd3f: v1.1

JSON Output

permguard authz ledgers update --zone-id 273165098782 --ledger-id 668f3771eacf4094ba8a80942ea5fd3f v1.1 --output json

output:

{
  "ledgers": [
    {
      "ledger_id": "668f3771eacf4094ba8a80942ea5fd3f",
      "created_at": "2024-08-25T14:50:38.003Z",
      "updated_at": "2024-08-25T15:10:22.003Z",
      "zone_id": 273165098782,
      "name": "v1.1"
    }
  ]
}

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: root

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": "bafyreiaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}