kych

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

kych-oauth2-gateway.1.rst (1419B)


      1 kych-oauth2-gateway(1)
      2 ######################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **kych-oauth2-gateway** - HTTP server providing OAuth 2.0 endpoints for KYC verification
     10 
     11 
     12 Synopsis
     13 ========
     14 
     15 **kych-oauth2-gateway**
     16 [**-c** *FILE* | **--config=**\ ‌\ *FILE*]
     17 [**-L** *LEVEL* | **--log-level=**\ \ *LEVEL*]
     18 [**-h** | **--help**]
     19 [**-V** | **--version**]
     20 
     21 
     22 Description
     23 ===========
     24 
     25 **kych-oauth2-gateway** is an HTTP server that provides OAuth 2.0 endpoints
     26 for KYC (Know Your Customer) verification using OID4VP (OpenID for Verifiable
     27 Presentations) with the Swiyu Verifier.
     28 
     29 Its options are as follows:
     30 
     31 **-c** *FILE* \| **--config=**\ ‌\ *FILE*
     32    Use the configuration from *FILE*. This option is required.
     33 
     34 **-L** *LEVEL* \| **--log-level=**\ \ *LEVEL*
     35    Set the logging verbosity to *LEVEL*. Valid values are ERROR, WARN,
     36    INFO, DEBUG, and TRACE. Defaults to INFO.
     37 
     38 **-h** \| **--help**
     39    Print short help on options.
     40 
     41 **-V** \| **--version**
     42    Print version information.
     43 
     44 
     45 Examples
     46 ========
     47 
     48 Start the server with a configuration file:
     49 
     50 .. code-block:: shell
     51 
     52    $ kych-oauth2-gateway -c /etc/kych/kych.conf
     53 
     54 Start the server with debug logging enabled:
     55 
     56 .. code-block:: shell
     57 
     58    $ kych-oauth2-gateway -c /etc/kych/kych.conf -L DEBUG
     59 
     60 
     61 See Also
     62 ========
     63 
     64 kych.conf(5), kych-client-management(1).
     65 
     66 
     67 Bugs
     68 ====
     69 
     70 Report bugs by using https://bugs.taler.net or by sending electronic
     71 mail to <taler@gnu.org>.