Skip to content

Commit 044a0c8

Browse files
vector-kerrn2ygk
andauthored
Update createapplication command docs to mimic CLI help text output
Co-authored-by: Alan Crosswell <[email protected]>
1 parent db85af9 commit 044a0c8

File tree

1 file changed

+25
-21
lines changed

1 file changed

+25
-21
lines changed

docs/management_commands.rst

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,24 +38,28 @@ This command is used like this:
3838
python3 manage.py createapplication [arguments] <client_type> <authorization_grant_type>
3939
4040
41-
This command provides the following arguments:
42-
43-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
44-
| Argument | type | Description |
45-
+============================+======+=================================================================================================+
46-
| `--client_id` | str | The ID of the new application |
47-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
48-
| `--user` | int | The ID of the user that the application belongs to |
49-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
50-
| `--redirect-uris` | str | The redirect URIs. This must be a space-separated string (e.g., `"https://uri1/ https://uri2"`) |
51-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
52-
| `--name` | str | The name of this application |
53-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
54-
| `--skip-authorization` | flag | If set, completely bypass the authorization form, even on the first use of the application |
55-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
56-
| `--algorithm` | str | The OIDC token signing algorithm for this application (e.g., `RS256` or `HS256`) |
57-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
58-
| `client_type` | str | The client type, can be `confidential` or `public` |
59-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
60-
| `authorization_grant_type` | str | The type of authorization grant to be used |
61-
+----------------------------+------+-------------------------------------------------------------------------------------------------+
41+
usage: manage.py createapplication [-h] [--client-id CLIENT_ID] [--user USER] [--redirect-uris REDIRECT_URIS]
42+
[--client-secret CLIENT_SECRET] [--name NAME] [--skip-authorization] [--version] [-v {0,1,2,3}]
43+
[--settings SETTINGS] [--pythonpath PYTHONPATH] [--traceback] [--no-color] [--force-color]
44+
[--skip-checks]
45+
client_type authorization_grant_type
46+
47+
Shortcut to create a new application in a programmatic way
48+
49+
positional arguments:
50+
client_type The client type, can be confidential or public
51+
authorization_grant_type
52+
The type of authorization grant to be used
53+
54+
optional arguments:
55+
-h, --help show this help message and exit
56+
--client-id CLIENT_ID
57+
The ID of the new application
58+
--user USER The user the application belongs to
59+
--redirect-uris REDIRECT_URIS
60+
The redirect URIs, this must be a space separated string e.g 'URI1 URI2'
61+
--client-secret CLIENT_SECRET
62+
The secret for this application
63+
--name NAME The name this application
64+
--skip-authorization The ID of the new application
65+
...

0 commit comments

Comments
 (0)