From 8d4506c9f45b60d3d40a84b475f265c70f60e89a Mon Sep 17 00:00:00 2001 From: ory-bot <60093411+ory-bot@users.noreply.github.com> Date: Fri, 8 Nov 2024 15:39:30 +0000 Subject: [PATCH] autogen(docs): generate cli docs --- docs/cli/ory-create-oauth2-client.md | 3 ++- docs/cli/ory-perform-authorization-code.md | 10 ++++++---- docs/cli/ory-perform.md | 2 +- docs/cli/ory-update-oauth2-client.md | 1 + 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/cli/ory-create-oauth2-client.md b/docs/cli/ory-create-oauth2-client.md index bfdef4ba0..86cb0c7f4 100644 --- a/docs/cli/ory-create-oauth2-client.md +++ b/docs/cli/ory-create-oauth2-client.md @@ -32,7 +32,7 @@ ory create oauth2-client [flags] ``` ory create oauth2-client -n "my app" -c http://localhost/cb -g authorization_code -r code -a core,foobar -Use the tool jq (or any other JSON tool) to get the OAuth2 Client ID and and Secret: +Use the tool jq (or any other JSON tool) to get the OAuth2 Client ID and Secret: client=$(ory create oauth2-client \ --format json \ @@ -55,6 +55,7 @@ client_secret=$(echo $client | jq -r '.client_secret') --client-uri string A URL string of a web page providing information about the client --contact strings A list representing ways to contact people responsible for this client, typically email addresses. -e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable. + --file string Read a JSON file representing a client from this location. If set, the other client flags are ignored. --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default") --frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra. --frontchannel-logout-session-required Boolean flag specifying whether the client requires that a sid (session ID) Claim be included in the Logout Token to identify the client session with the OP when the frontchannel-logout-callback is used. If omitted, the default value is false. diff --git a/docs/cli/ory-perform-authorization-code.md b/docs/cli/ory-perform-authorization-code.md index b43610043..e0349fdcc 100644 --- a/docs/cli/ory-perform-authorization-code.md +++ b/docs/cli/ory-perform-authorization-code.md @@ -1,7 +1,7 @@ --- id: ory-perform-authorization-code title: ory perform authorization-code -description: ory perform authorization-code An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow +description: ory perform authorization-code Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow --- ## ory perform authorization-code -An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow +Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow ### Synopsis -Starts an exemplary web server that acts as an OAuth 2.0 Client performing the Authorize Code Flow. +Starts an example web server that acts as an OAuth 2.0 Client performing the Authorize Code Flow. This command will help you to see if Ory Hydra has been configured properly. This command must not be used for anything else than manual testing or demo purposes. The server will terminate on error @@ -42,7 +42,7 @@ ory perform authorization-code --client-id ... --client-secret ... --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default") -h, --help help for authorization-code --https Sets up HTTPS for the endpoint using a self-signed certificate which is re-generated every time you start this command - --max-age int Set the OpenID Connect max_age parameter + --max-age int Set the OpenID Connect max_age parameter. -1 means no max_age parameter will be used. (default -1) --no-open Do not open the browser window automatically --no-shutdown Do not terminate on success/error. State and nonce will be regenerated when auth flow has completed (either due to an error or success). -p, --port int The port on which the server should run (default 4446) @@ -50,7 +50,9 @@ ory perform authorization-code --client-id ... --client-secret ... --prompt strings Set the OpenID Connect prompt parameter -q, --quiet Be quiet with output printing. --redirect string Force a redirect url + --response-mode string Set the response mode. Can be query (default) or form_post. --scope strings Request OAuth2 scope (default [offline,openid]) + --skip Skip login and/or consent steps if possible. Only effective if you have configured the Login and Consent UI URLs to point to this server. --state string Force a state value (insecure) --token-url endpoint Usually it is enough to specify the endpoint flag, but if you want to force the token url, use this flag --workspace string The workspace to use, either workspace ID or a (partial) name. diff --git a/docs/cli/ory-perform.md b/docs/cli/ory-perform.md index 0a6651531..c1ccbbba7 100644 --- a/docs/cli/ory-perform.md +++ b/docs/cli/ory-perform.md @@ -25,6 +25,6 @@ Perform a flow ### SEE ALSO * [ory](ory) - The Ory CLI -* [ory perform authorization-code](ory-perform-authorization-code) - An exemplary OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow +* [ory perform authorization-code](ory-perform-authorization-code) - Example OAuth 2.0 Client performing the OAuth 2.0 Authorize Code Flow * [ory perform client-credentials](ory-perform-client-credentials) - Perform the OAuth2 Client Credentials Flow diff --git a/docs/cli/ory-update-oauth2-client.md b/docs/cli/ory-update-oauth2-client.md index 75e371143..8c9309370 100644 --- a/docs/cli/ory-update-oauth2-client.md +++ b/docs/cli/ory-update-oauth2-client.md @@ -43,6 +43,7 @@ To encrypt an auto-generated OAuth2 Client Secret, use flags `--pgp-key`, `--pgp --client-uri string A URL string of a web page providing information about the client --contact strings A list representing ways to contact people responsible for this client, typically email addresses. -e, --endpoint string The URL of Ory Kratos' Admin API. Alternatively set using the KRATOS_ADMIN_URL environmental variable. + --file string Read a JSON file representing a client from this location. If set, the other client flags are ignored. --format string Set the output format. One of table, json, yaml, json-pretty, jsonpath and jsonpointer. (default "default") --frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra. --frontchannel-logout-session-required Boolean flag specifying whether the client requires that a sid (session ID) Claim be included in the Logout Token to identify the client session with the OP when the frontchannel-logout-callback is used. If omitted, the default value is false.