kych

OAuth 2.0 API for Swiyu to enable Taler integration of Swiyu for KYC (experimental)
Log | Files | Refs | README

kych-client-management.1.rst (2726B)

      1 kych-client-management(1)
      2 #########################
      3 
      4 Name
      5 ====
      6 
      7 **kych-client-management** - Manage OAuth2 Gateway clients for KyCH
      8 
      9 Synopsis
     10 ========
     11 
     12 **kych-client-management** [**-c** *CONFIG* | **--config=**\ \ *CONFIG*] *COMMAND* [*OPTIONS*]
     13 
     14 Description
     15 ===========
     16 
     17 **kych-client-management** is a command-line tool for managing OAuth2 clients
     18 in the KyCH OAuth2 Gateway. It allows administrators to create, update, delete,
     19 list, and synchronize client configurations stored in the database.
     20 
     21 Global Options
     22 ==============
     23 
     24 **-c** *CONFIG* \| **--config=**\ \ *CONFIG*
     25   Use the configuration file *CONFIG*. This option is required for all commands.
     26 
     27 Commands
     28 ========
     29 
     30 list
     31 ----
     32 
     33 List all registered OAuth2 clients.
     34 
     35 **kych-client-management** **-c** *CONFIG* **list**
     36 
     37 show
     38 ----
     39 
     40 Show details of a specific OAuth2 client.
     41 
     42 **kych-client-management** **-c** *CONFIG* **show** *CLIENT_ID*
     43 
     44 *CLIENT_ID*
     45   The identifier of the client to display.
     46 
     47 create
     48 ------
     49 
     50 Create a new OAuth2 client.
     51 
     52 **kych-client-management** **-c** *CONFIG* **create** [*OPTIONS*]
     53 
     54 **--client-id=**\ \ *CLIENT_ID*
     55   The unique identifier for the new client. Required.
     56 
     57 **--secret=**\ \ *SECRET*
     58   The client secret for authentication. Required.
     59 
     60 **--verifier-url=**\ \ *URL*
     61   The URL of the verifier service. Required.
     62 
     63 **--verifier-api-path=**\ \ *PATH*
     64   The API path on the verifier for verifications.
     65   Default: ``/management/api/verifications``
     66 
     67 **--redirect-uri=**\ \ *URI*
     68   The OAuth2 redirect URI for this client. Required.
     69 
     70 **--accepted-issuer-dids=**\ \ *DIDS*
     71   Comma-separated list of accepted issuer DIDs.
     72 
     73 update
     74 ------
     75 
     76 Update an existing OAuth2 client. At least one option must be provided.
     77 
     78 **kych-client-management** **-c** *CONFIG* **update** *CLIENT_ID* [*OPTIONS*]
     79 
     80 *CLIENT_ID*
     81   The identifier of the client to update.
     82 
     83 **--verifier-url=**\ \ *URL*
     84   Update the verifier service URL.
     85 
     86 **--verifier-api-path=**\ \ *PATH*
     87   Update the verifier API path.
     88 
     89 **--redirect-uri=**\ \ *URI*
     90   Update the OAuth2 redirect URI.
     91 
     92 **--accepted-issuer-dids=**\ \ *DIDS*
     93   Update the accepted issuer DIDs.
     94 
     95 delete
     96 ------
     97 
     98 Delete an OAuth2 client.
     99 
    100 **kych-client-management** **-c** *CONFIG* **delete** [*OPTIONS*] *CLIENT_ID*
    101 
    102 *CLIENT_ID*
    103   The identifier of the client to delete.
    104 
    105 **-y** \| **--yes**
    106   Skip the confirmation prompt.
    107 
    108 sync
    109 ----
    110 
    111 Synchronize clients from the configuration file to the database.
    112 
    113 **kych-client-management** **-c** *CONFIG* **sync** [*OPTIONS*]
    114 
    115 **--prune**
    116   Remove clients from the database that are not present in the configuration file.
    117 
    118 See Also
    119 ========
    120 
    121 kych.conf(5), kych-oauth2-gateway(1)
    122 
    123 Bugs
    124 ====
    125 
    126 Report bugs by using https://bugs.taler.net/ or by sending electronic
    127 mail to <taler@gnu.org>.