Skip to content

Commit 6e27e3b

Browse files
committed
autogen(docs): generate cli docs
1 parent f2fc583 commit 6e27e3b

File tree

2 files changed

+51
-49
lines changed

2 files changed

+51
-49
lines changed

docs/hydra/cli/hydra-clients-create.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,32 @@ hydra clients create [flags]
3535
### Options
3636

3737
```
38-
--allowed-cors-origins strings The list of URLs allowed to make CORS requests. Requires CORS_ENABLED.
39-
--audience strings The audience this client is allowed to request
40-
--backchannel-logout-callback string Client URL that will cause the client to log itself out when sent a Logout Token by Hydra.
41-
--backchannel-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 backchannel-logout-callback is used. If omitted, the default value is false.
42-
-c, --callbacks strings REQUIRED list of allowed callback URLs
43-
--client-uri string A URL string of a web page providing information about the client
44-
--frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra.
45-
--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.
46-
-g, --grant-types strings A list of allowed grant types (default [authorization_code])
47-
-h, --help help for create
48-
--id string Give the client this id
49-
--jwks-uri string Define the URL where the JSON Web Key Set should be fetched from when performing the "private_key_jwt" client authentication method
50-
--keybase string Keybase username for encrypting client secret
51-
--logo-uri string A URL string that references a logo for the client
52-
-n, --name string The client's name
53-
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret
54-
--pgp-key-url string PGP encryption key URL for encrypting client secret
55-
--policy-uri string A URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data
56-
--post-logout-callbacks strings List of allowed URLs to be redirected to after a logout
57-
-r, --response-types strings A list of allowed response types (default [code])
58-
-a, --scope strings The scope the client is allowed to request
59-
--secret string Provide the client's secret
60-
--subject-type string A identifier algorithm. Valid values are "public" and "pairwise" (default "public")
61-
--token-endpoint-auth-method string Define which authentication method the client may use at the Token Endpoint. Valid values are "client_secret_post", "client_secret_basic", "private_key_jwt", and "none" (default "client_secret_basic")
62-
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client
38+
--allowed-cors-origins strings The list of URLs allowed to make CORS requests. Requires CORS_ENABLED.
39+
--audience strings The audience this client is allowed to request
40+
--backchannel-logout-callback string Client URL that will cause the client to log itself out when sent a Logout Token by Hydra.
41+
--backchannel-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 backchannel-logout-callback is used. If omitted, the default value is false.
42+
-c, --callbacks strings REQUIRED list of allowed callback URLs
43+
--client-uri string A URL string of a web page providing information about the client
44+
--frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra.
45+
--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.
46+
-g, --grant-types strings A list of allowed grant types (default [authorization_code])
47+
-h, --help help for create
48+
--id string Give the client this id
49+
--jwks-uri string Define the URL where the JSON Web Key Set should be fetched from when performing the "private_key_jwt" client authentication method
50+
--keybase string Keybase username for encrypting client secret
51+
--logo-uri string A URL string that references a logo for the client
52+
-n, --name string The client's name
53+
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret
54+
--pgp-key-url string PGP encryption key URL for encrypting client secret
55+
--policy-uri string A URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data
56+
--post-logout-callbacks strings List of allowed URLs to be redirected to after a logout
57+
-r, --response-types strings A list of allowed response types (default [code])
58+
-a, --scope strings The scope the client is allowed to request
59+
--secret string Provide the client's secret
60+
--subject-type string A identifier algorithm. Valid values are "public" and "pairwise" (default "public")
61+
--token-endpoint-auth-method string Define which authentication method the client may use at the Token Endpoint. Valid values are "client_secret_post", "client_secret_basic", "private_key_jwt", and "none" (default "client_secret_basic")
62+
--token-endpoint-auth-signing-alg string Authentication signing algorithm for the Token Endpoint
63+
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client
6364
```
6465

6566
### Options inherited from parent commands

docs/hydra/cli/hydra-clients-update.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -34,30 +34,31 @@ hydra clients update <id> [flags]
3434
### Options
3535

3636
```
37-
--allowed-cors-origins strings The list of URLs allowed to make CORS requests. Requires CORS_ENABLED.
38-
--audience strings The audience this client is allowed to request
39-
--backchannel-logout-callback string Client URL that will cause the client to log itself out when sent a Logout Token by Hydra.
40-
--backchannel-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 backchannel-logout-callback is used. If omitted, the default value is false.
41-
-c, --callbacks strings REQUIRED list of allowed callback URLs
42-
--client-uri string A URL string of a web page providing information about the client
43-
--frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra.
44-
--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.
45-
-g, --grant-types strings A list of allowed grant types (default [authorization_code])
46-
-h, --help help for update
47-
--jwks-uri string Define the URL where the JSON Web Key Set should be fetched from when performing the "private_key_jwt" client authentication method
48-
--keybase string Keybase username for encrypting client secret
49-
--logo-uri string A URL string that references a logo for the client
50-
-n, --name string The client's name
51-
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret
52-
--pgp-key-url string PGP encryption key URL for encrypting client secret
53-
--policy-uri string A URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data
54-
--post-logout-callbacks strings List of allowed URLs to be redirected to after a logout
55-
-r, --response-types strings A list of allowed response types (default [code])
56-
-a, --scope strings The scope the client is allowed to request
57-
--secret string Provide the client's secret
58-
--subject-type string A identifier algorithm. Valid values are "public" and "pairwise" (default "public")
59-
--token-endpoint-auth-method string Define which authentication method the client may use at the Token Endpoint. Valid values are "client_secret_post", "client_secret_basic", "private_key_jwt", and "none" (default "client_secret_basic")
60-
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client
37+
--allowed-cors-origins strings The list of URLs allowed to make CORS requests. Requires CORS_ENABLED.
38+
--audience strings The audience this client is allowed to request
39+
--backchannel-logout-callback string Client URL that will cause the client to log itself out when sent a Logout Token by Hydra.
40+
--backchannel-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 backchannel-logout-callback is used. If omitted, the default value is false.
41+
-c, --callbacks strings REQUIRED list of allowed callback URLs
42+
--client-uri string A URL string of a web page providing information about the client
43+
--frontchannel-logout-callback string Client URL that will cause the client to log itself out when rendered in an iframe by Hydra.
44+
--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.
45+
-g, --grant-types strings A list of allowed grant types (default [authorization_code])
46+
-h, --help help for update
47+
--jwks-uri string Define the URL where the JSON Web Key Set should be fetched from when performing the "private_key_jwt" client authentication method
48+
--keybase string Keybase username for encrypting client secret
49+
--logo-uri string A URL string that references a logo for the client
50+
-n, --name string The client's name
51+
--pgp-key string Base64 encoded PGP encryption key for encrypting client secret
52+
--pgp-key-url string PGP encryption key URL for encrypting client secret
53+
--policy-uri string A URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data
54+
--post-logout-callbacks strings List of allowed URLs to be redirected to after a logout
55+
-r, --response-types strings A list of allowed response types (default [code])
56+
-a, --scope strings The scope the client is allowed to request
57+
--secret string Provide the client's secret
58+
--subject-type string A identifier algorithm. Valid values are "public" and "pairwise" (default "public")
59+
--token-endpoint-auth-method string Define which authentication method the client may use at the Token Endpoint. Valid values are "client_secret_post", "client_secret_basic", "private_key_jwt", and "none" (default "client_secret_basic")
60+
--token-endpoint-auth-signing-alg string Authentication signing algorithm for the Token Endpoint
61+
--tos-uri string A URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client
6162
```
6263

6364
### Options inherited from parent commands

0 commit comments

Comments
 (0)