|
Line 0
Link Here
|
| 0 |
- |
1 |
<article xmlns='http://docbook.org/ns/docbook'> |
|
|
2 |
<title>koha-api-keys</title> |
| 3 |
|
| 4 |
<info> |
| 5 |
<productname>Koha</productname> |
| 6 |
<author> |
| 7 |
<personname> |
| 8 |
<firstname>Paul</firstname> |
| 9 |
<surname>Derscheid</surname> |
| 10 |
</personname> |
| 11 |
<affiliation> |
| 12 |
<orgname>LMSCloud GmbH</orgname> |
| 13 |
<uri>http://lmscloud.de</uri> |
| 14 |
</affiliation> |
| 15 |
<contrib>Author</contrib> |
| 16 |
</author> |
| 17 |
</info> |
| 18 |
|
| 19 |
<refentry xml:id="koha-api-keys"> |
| 20 |
<refmeta> |
| 21 |
<refentrytitle>koha-api-keys</refentrytitle> |
| 22 |
<manvolnum>8</manvolnum> |
| 23 |
</refmeta> |
| 24 |
|
| 25 |
<refnamediv> |
| 26 |
<refname>koha-api-keys</refname> |
| 27 |
<refpurpose>Manage API keys for patrons in a Koha instance.</refpurpose> |
| 28 |
</refnamediv> |
| 29 |
|
| 30 |
<refsynopsisdiv> |
| 31 |
<cmdsynopsis> |
| 32 |
<command>koha-api-keys</command> |
| 33 |
<arg choice="req">generate | delete</arg> |
| 34 |
<arg choice="opt"><replaceable>description</replaceable></arg> |
| 35 |
<arg choice="opt"><replaceable>borrowernumber</replaceable></arg> |
| 36 |
<arg choice="opt"><replaceable>instancename</replaceable></arg> |
| 37 |
</cmdsynopsis> |
| 38 |
</refsynopsisdiv> |
| 39 |
|
| 40 |
<refsect1> |
| 41 |
<title>Description</title> |
| 42 |
<para> |
| 43 |
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. |
| 44 |
</para> |
| 45 |
</refsect1> |
| 46 |
|
| 47 |
<refsect1> |
| 48 |
<title>Description</title> |
| 49 |
<para> |
| 50 |
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. |
| 51 |
</para> |
| 52 |
</refsect1> |
| 53 |
|
| 54 |
<refsect1> |
| 55 |
<title>Arguments</title> |
| 56 |
<variablelist> |
| 57 |
<varlistentry> |
| 58 |
<term><replaceable>generate</replaceable></term> |
| 59 |
<listitem> |
| 60 |
<para>Generates a new API key for the specified patron.</para> |
| 61 |
</listitem> |
| 62 |
</varlistentry> |
| 63 |
<varlistentry> |
| 64 |
<term><replaceable>delete</replaceable></term> |
| 65 |
<listitem> |
| 66 |
<para>Deletes an existing API key based on its Client ID.</para> |
| 67 |
</listitem> |
| 68 |
</varlistentry> |
| 69 |
<varlistentry> |
| 70 |
<term><replaceable>description</replaceable></term> |
| 71 |
<listitem> |
| 72 |
<para>A description for the API key.</para> |
| 73 |
</listitem> |
| 74 |
</varlistentry> |
| 75 |
<varlistentry> |
| 76 |
<term><replaceable>borrowernumber</replaceable></term> |
| 77 |
<listitem> |
| 78 |
<para>The borrower number of the patron to associate the API key with.</para> |
| 79 |
</listitem> |
| 80 |
</varlistentry> |
| 81 |
<varlistentry> |
| 82 |
<term><replaceable>instancename</replaceable></term> |
| 83 |
<listitem> |
| 84 |
<para>The name of the Koha instance to operate on.</para> |
| 85 |
</listitem> |
| 86 |
</varlistentry> |
| 87 |
</variablelist> |
| 88 |
</refsect1> |
| 89 |
|
| 90 |
<refsect1> |
| 91 |
<title>Examples</title> |
| 92 |
<para>Generate a new API key for patron '12345' with the description 'Patron Access':</para> |
| 93 |
<screen>$ koha-api-keys generate 'Patron Access' 12345 kohadev</screen> |
| 94 |
|
| 95 |
<para>Delete an existing API key with Client ID 'abc123def456':</para> |
| 96 |
<screen>$ koha-api-keys delete abc123def456 kohadev</screen> |
| 97 |
</refsect1> |
| 98 |
</refentry> |
| 99 |
</article> |
| 100 |
|