openid-client-cli

CLI for managing dynamic OpenID Connect client registrations.

Table of Contents

• Prerequisites
• Install
• Commands
  • create
  • read
  • update
  • edit
  • delete

Prerequisites

Your OpenID Provider must support:

• Dynamic Registration for create and read.
• Registration Management Protocol for update and delete.

Install

Via npm:

$ npm install -g openid-client-cli

Via yarn:

$ yarn global add openid-client-cli

Commands

create

openid-client create --help

Example:
openid-client create https://op.example.com/client/register \
  redirect_uris=[https://rp.example.com/callback,https://rp.example.com/forum/callback] \
  response_types=code \
  grant_types=authorization_code,refresh_token \
  require_auth_time=true \
  client_name='My Client 1.0'

read

openid-client read --help

Example:
openid-client read --token=<registration_access_token> --uri=<registration_client_uri>

update

openid-client update --help

Example:
openid-client update --token=<registration_access_token> --uri=<registration_client_uri> \
  client_name=null

edit

Similar to update but opens a text editor specified via $EDITOR and updates the client with the result. Make sure to have your editor configured properly to stay in the foreground (e.g. EDITOR="code --wait" for VS Code).

openid-client edit --help

Example:
openid-client edit --token=<registration_access_token> --uri=<registration_client_uri>

delete

openid-client delete --help

Example:
openid-client delete --token=<registration_access_token> --uri=<registration_client_uri>