Bugzilla – Attachment 167524 Details for
Bug 37025
Add CLI tool to generate/delete api keys for a given patron on a Koha instance
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 37025: (follow-up) Add missing docbook xml for koha-api-keys
Bug-37025-follow-up-Add-missing-docbook-xml-for-ko.patch (text/plain), 4.59 KB, created by
Paul Derscheid
on 2024-06-06 07:26:36 UTC
(
hide
)
Description:
Bug 37025: (follow-up) Add missing docbook xml for koha-api-keys
Filename:
MIME Type:
Creator:
Paul Derscheid
Created:
2024-06-06 07:26:36 UTC
Size:
4.59 KB
patch
obsolete
>From 443ff10d60e8363b2c42c06f9739955e2e774416 Mon Sep 17 00:00:00 2001 >From: Paul Derscheid <paul.derscheid@lmscloud.de> >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 @@ >+<article xmlns='http://docbook.org/ns/docbook'> >+ <title>koha-api-keys</title> >+ >+ <info> >+ <productname>Koha</productname> >+ <author> >+ <personname> >+ <firstname>Paul</firstname> >+ <surname>Derscheid</surname> >+ </personname> >+ <affiliation> >+ <orgname>LMSCloud GmbH</orgname> >+ <uri>http://lmscloud.de</uri> >+ </affiliation> >+ <contrib>Author</contrib> >+ </author> >+ </info> >+ >+ <refentry xml:id="koha-api-keys"> >+ <refmeta> >+ <refentrytitle>koha-api-keys</refentrytitle> >+ <manvolnum>8</manvolnum> >+ </refmeta> >+ >+ <refnamediv> >+ <refname>koha-api-keys</refname> >+ <refpurpose>Manage API keys for patrons in a Koha instance.</refpurpose> >+ </refnamediv> >+ >+ <refsynopsisdiv> >+ <cmdsynopsis> >+ <command>koha-api-keys</command> >+ <arg choice="req">generate | delete</arg> >+ <arg choice="opt"><replaceable>description</replaceable></arg> >+ <arg choice="opt"><replaceable>borrowernumber</replaceable></arg> >+ <arg choice="opt"><replaceable>instancename</replaceable></arg> >+ </cmdsynopsis> >+ </refsynopsisdiv> >+ >+ <refsect1> >+ <title>Description</title> >+ <para> >+ The <command>koha-api-keys</command> 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. >+ </para> >+ </refsect1> >+ >+<refsect1> >+ <title>Description</title> >+ <para> >+ The <command>koha-api-keys</command> 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. >+ </para> >+ </refsect1> >+ >+ <refsect1> >+ <title>Arguments</title> >+ <variablelist> >+ <varlistentry> >+ <term><replaceable>generate</replaceable></term> >+ <listitem> >+ <para>Generates a new API key for the specified patron.</para> >+ </listitem> >+ </varlistentry> >+ <varlistentry> >+ <term><replaceable>delete</replaceable></term> >+ <listitem> >+ <para>Deletes an existing API key based on its Client ID.</para> >+ </listitem> >+ </varlistentry> >+ <varlistentry> >+ <term><replaceable>description</replaceable></term> >+ <listitem> >+ <para>A description for the API key.</para> >+ </listitem> >+ </varlistentry> >+ <varlistentry> >+ <term><replaceable>borrowernumber</replaceable></term> >+ <listitem> >+ <para>The borrower number of the patron to associate the API key with.</para> >+ </listitem> >+ </varlistentry> >+ <varlistentry> >+ <term><replaceable>instancename</replaceable></term> >+ <listitem> >+ <para>The name of the Koha instance to operate on.</para> >+ </listitem> >+ </varlistentry> >+ </variablelist> >+ </refsect1> >+ >+ <refsect1> >+ <title>Examples</title> >+ <para>Generate a new API key for patron '12345' with the description 'Patron Access':</para> >+ <screen>$ koha-api-keys generate 'Patron Access' 12345 kohadev</screen> >+ >+ <para>Delete an existing API key with Client ID 'abc123def456':</para> >+ <screen>$ koha-api-keys delete abc123def456 kohadev</screen> >+ </refsect1> >+ </refentry> >+</article> >+ >-- >2.45.2
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 37025
:
167397
| 167524 |
171014