vinelab/oauth-clients-generator-redis

Redis Client Generator for the League's PHP OAuth 2.0 server

Redis OAuth2 Client Generator

, _(*1)

Redis Client Generator to be used with ThePhpLeague's OAuth2 Package, _(*2)

Quick Reference

• Installation
• Commands

Installation

Composer

Use the command:, _(*3)

composer require vinelab/oauth-clients-generator-redis

otherwise, add:, _(*4)

"vinelab/oauth-clients-generator-redis": "dev-master", _(*5)

to your composer.json file and do a composer update., _(*6)

Commands

Client Generator comes with a handy command line tool for usage straight from the command line. Once you install using composer an oauth binary will be in your vendor/bin/. To make things easier you can run, _(*7)

export PATH="./vendor/bin:$PATH" to use oauth straight instead of ./vendor/bin/oauth, _(*8)

use oauth list for a list of available commands and oauth --help [command] for more info about each of them., _(*9)

Commands

• oauth
  • Options
    • clients:create: Create a new client
    • clients:delete: Delete a specific client
    • clients:list: List all available clients
    • clients:fetch: Fetch a specific client
      • --show-secret: Show a specific client's secret
    • clients:regenerate-secret: Re-generate a client's secret

Create Client

In order to create a new client, use the command:, _(*10)

oauth clients:create {name} {password} {redirect_uri = ''} {grantType = 'client_credentials'},, _(*11)

where:, _(*12)

name => The name of the application [REQUIRED],, _(*13)

password => A password to use when you need to delete a client or re-generate his secret [REQUIRED],, _(*14)

redirect_uri => The redirect URI you want to make use of [OPTIONAL],, _(*15)

grantType => The grant type you want to use [OPTIONAL], _(*16)

Delete Client

In order to delete a specific client, use the command:, _(*17)

oauth clients:delete {client_id} {password},, _(*18)

where:, _(*19)

client_id => The client's id [REQUIRED],, _(*20)

password => The password the user used when created the client [REQUIRED], _(*21)

List Clients

In order to list all available clients, use the command:, _(*22)

oauth clients:list., _(*23)

Fetch Client (or client's secret)

In order to fetch a specific client or just fetch a client's secret, use the command:, _(*24)

oauth clients:fetch {client_id},, _(*25)

where:, _(*26)

client_id => The client's id [REQUIRED],, _(*27)

and in case you want to fetch a specific user's secret, you can use the --show-secret flag in the command:, _(*28)

eg. oauth clients:fetch {client_id} --show-secret {password}, _(*29)

where:, _(*30)

password => The password the user used when created the client [REQUIRED], _(*31)

Re-generate Client's Secret

In order to re-generate a specific client's secret, use the command:, _(*32)

oauth clients:regenerate-secret {client_id} {password},, _(*33)

where:, _(*34)

client_id => The client's id [REQUIRED],, _(*35)

password => The password the user used when created the client [REQUIRED], _(*36)