- 

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