cups-oauth(1) — Linux manual page

cups-oauth(1)                  OpenPrinting                 cups-oauth(1)

NAME         top

       cups-oauth - interact with an oauth/openid authorization server

SYNOPSIS         top

       cups-oauth --help
       cups-oauth --version
       cups-oauth [ -a OAUTH-URI ] [ -s SCOPE(S) ] authorize [RESOURCE]
       cups-oauth [ -a OAUTH-URI ] clear [RESOURCE]
       cups-oauth [ -a OAUTH-URI ] get-access-token [RESOURCE]
       cups-oauth [ -a OAUTH-URI ] get-client-id
       cups-oauth [ -a OAUTH-URI ] get-metadata [NAME]
       cups-oauth [ -a OAUTH-URI ] get-user-id [RESOURCE] [NAME]
       cups-oauth [ -a OAUTH-URI ] set-access-token [RESOURCE] TOKEN
       cups-oauth [ -a OAUTH-URI ] set-client-data CLIENT-ID CLIENT-
       SECRET

DESCRIPTION         top

       The cups-oauth utility interacts with an OAuth/OpenID
       authorization server.  Authorizations are often linked to a
       resource (a printer URI, web page URL, etc.)

OPTIONS         top

       The following options are recognized by cups-oauth:

       --help
            Show program usage.

       --version
            Show the CUPS version.

       -a OAUTH-URI
            Specifies the OAuth/OpenID authorization server URL.

       -s SCOPE(S)
            Specifies a space-delimited list of scope names to use when
            authorizing access.  The default is to request authorization
            for all supported OpenID scopes.

SUB-COMMANDS         top

   authorize
       Starts an authorization workflow with the default web browser.  If
       a resource URI is specified, the authorization is specific to that
       resource.  The access token is send to the standard output on
       success.

   clear
       Clears any authorization for the specified resource or for all
       resources if no resource URI is supplied.

   get-access-token
       Output the current, unexpired access token, if any, to the
       standard output.

   get-client-id
       Output the client ID string, if any, to the standard output.

   get-metadata
       Get the OAuth/OpenID authorization server metadata and send it to
       the standard output.  If a name is specified, the output is just
       the value for the specified metadata.

   get-user-id
       Get the OpenID user ID information and send it to the standard
       output.  If a name is specified, the output is just the named
       claim from the user ID.

   set-access-token
       Set the access token (which is sometimes also called an API key)
       for the specified resource or for all resources.

   set-client-data
       Set the client ID string and secret for an OAuth/OpenID
       authorization server.

ENVIRONMENT VARIABLES         top

       The CUPS_OAUTH_URI environment variable sets the default
       OAuth/OpenID authorization server URL.

       The CUPS_OAUTH_SCOPES environment variable sets the default
       OAuth/OpenID scopes as a space-delimited list.

NOTES         top

       CUPS uses a redirect URI of "http://127.0.0.1/" for all
       authorization on the local system.

EXAMPLES         top

       Register a client ID and secret for the OAuth server at
       "https://oauth.example.com/":
            cups-oauth -a https://oauth.example.com/ set-client-data CLIENT-ID CLIENT-SECRET
       Save an access token (sometimes called an application or API key)
       for the OAuth server at "https://oauth.example.com/":
            cups-oauth -a https://oauth.example.com/ set-access-token TOKEN
       Authorize against the OAuth server at "https://oauth.example.com/"
       using your web browser:
            cups-oauth -a https://oauth.example.com/ authorize

SEE ALSO         top

       cups(1)

COPYRIGHT         top

       Copyright © 2025 by OpenPrinting.

COLOPHON         top

       This page is part of the CUPS (a standards-based, open source
       printing system) project.  Information about the project can be
       found at ⟨https://github.com/openprinting/cups⟩.  If you have a
       bug report for this manual page, see
       ⟨https://github.com/OpenPrinting/cups/issues⟩.  This page was
       obtained from the project's upstream Git repository
       ⟨https://github.com/openprinting/cups⟩ on 2025-08-11.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2025-08-07.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there is
       a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       [email protected]

2025-05-05                         CUPS                     cups-oauth(1)

HTML rendering created 2025-09-06 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.