From 443ff10d60e8363b2c42c06f9739955e2e774416 Mon Sep 17 00:00:00 2001 From: Paul Derscheid Date: Thu, 6 Jun 2024 09:16:50 +0200 Subject: [PATCH] Bug 37025: (follow-up) Add missing docbook xml for koha-api-keys --- debian/docs/koha-api-keys.xml | 100 ++++++++++++++++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 debian/docs/koha-api-keys.xml diff --git a/debian/docs/koha-api-keys.xml b/debian/docs/koha-api-keys.xml new file mode 100644 index 0000000000..994a19af58 --- /dev/null +++ b/debian/docs/koha-api-keys.xml @@ -0,0 +1,100 @@ +
+ koha-api-keys + + + Koha + + + Paul + Derscheid + + + LMSCloud GmbH + http://lmscloud.de + + Author + + + + + + koha-api-keys + 8 + + + + koha-api-keys + Manage API keys for patrons in a Koha instance. + + + + + koha-api-keys + generate | delete + description + borrowernumber + instancename + + + + + Description + + The koha-api-keys script allows administrators to generate or delete API keys associated with specific Koha patrons. These API keys can be used for authorized programmatic access to the Koha system. + + + + + Description + + The koha-api-keys script allows administrators to generate or delete API keys associated with specific Koha patrons. These API keys can be used for authorized programmatic access to the Koha system. + + + + + Arguments + + + generate + + Generates a new API key for the specified patron. + + + + delete + + Deletes an existing API key based on its Client ID. + + + + description + + A description for the API key. + + + + borrowernumber + + The borrower number of the patron to associate the API key with. + + + + instancename + + The name of the Koha instance to operate on. + + + + + + + Examples + Generate a new API key for patron '12345' with the description 'Patron Access': + $ koha-api-keys generate 'Patron Access' 12345 kohadev + + Delete an existing API key with Client ID 'abc123def456': + $ koha-api-keys delete abc123def456 kohadev + + +
+ -- 2.45.2