Skip to content

fix: client command example using v2 option #3943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2025
Merged

fix: client command example using v2 option #3943

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcbeb27
fix: client command example using v2 option
Ryuheeeei Feb 13, 2025
2099fad
fix: hydra import client message
Ryuheeeei Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cmd/cmd_create_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func NewCreateClientsCommand() *cobra.Command {
Short: "Create an OAuth 2.0 Client",
Aliases: []string{"client"},
Args: cobra.NoArgs,
Example: `{{ .CommandPath }} -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar
Example: `{{ .CommandPath }} --name "my app" --redirect-uri http://localhost/cb --grant-type authorization_code --response-type code --scope core,foobar

Use the tool jq (or any other JSON tool) to get the OAuth2 Client ID and Secret:

Expand All @@ -74,7 +74,7 @@ the Authorize Code, Implicit, Refresh flow. This command allows settings all fie

To encrypt an auto-generated OAuth2 Client Secret, use flags ` + "`--pgp-key`" + `, ` + "`--pgp-key-url`" + ` or ` + "`--keybase`" + ` flag, for example:

{{ .CommandPath }} -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username
{{ .CommandPath }} --name "my app" --grant-type client_credentials --response-type token --scope core,foobar --keybase keybase_username
`,
RunE: func(cmd *cobra.Command, args []string) error {
m, _, err := cliclient.NewClient(cmd)
Expand Down
2 changes: 1 addition & 1 deletion cmd/cmd_import_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Alternatively:

To encrypt an auto-generated OAuth2 Client Secret, use flags ` + "`--pgp-key`" + `, ` + "`--pgp-key-url`" + ` or ` + "`--keybase`" + ` flag, for example:

{{ .CommandPath }} -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username
hydra create client --name "my app" --grant-types client_credentials --response-type token --scope core,foobar --keybase keybase_username
Copy link
Contributor Author

@Ryuheeeei Ryuheeeei Feb 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't hydra import client command. Instead, it seems hydra create client, right ?
According to https://www.ory.sh/docs/hydra/cli/hydra-import-client, it seems hydra create client. Sorry if I misunderstood.

Copy link
Member

@aeneasr aeneasr Feb 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CommandPath variable automatically sets the correct name for the help command, so the previous version was correct :)

Copy link
Contributor Author

@Ryuheeeei Ryuheeeei Feb 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!
I reverted this change. 2099fad

`,
Long: `This command reads in each listed JSON file and imports their contents as a list of OAuth 2.0 Clients.

Expand Down
4 changes: 2 additions & 2 deletions cmd/cmd_update_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ func NewUpdateClientCmd() *cobra.Command {
Aliases: []string{"client"},
Short: "Update an OAuth 2.0 Client",
Args: cobra.ExactArgs(1),
Example: `{{ .CommandPath }} <client-id-here> -c http://localhost/cb -g authorization_code -r code -a core,foobar
Example: `{{ .CommandPath }} <client-id-here> --redirect-uri http://localhost/cb --grant-type authorization_code --response-type code --scope core,foobar

To encrypt an auto-generated OAuth2 Client Secret, use flags ` + "`--pgp-key`" + `, ` + "`--pgp-key-url`" + ` or ` + "`--keybase`" + ` flag, for example:

{{ .CommandPath }} e6e96aa5-9cd2-4a70-bf56-ad6434c8aaa2 -n "my app" -g client_credentials -r token -a core,foobar --keybase keybase_username
{{ .CommandPath }} e6e96aa5-9cd2-4a70-bf56-ad6434c8aaa2 --name "my app" --grant-type client_credentials --response-type token --scope core,foobar --keybase keybase_username
`,
Long: `This command replaces an OAuth 2.0 Client by its ID. Please be aware that this command replaces the entire client. If only the name flag (-n "my updated app") is provided, the all other fields are updated to their default values.`,
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
Loading