-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add more self-generating documentation, add an example configuration …
…file
- Loading branch information
Showing
5 changed files
with
126 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
% duocli 8 | ||
|
||
# NAME | ||
|
||
duocli - CLI Interface to Duo Admin API | ||
|
||
# SYNOPSIS | ||
|
||
duocli | ||
|
||
``` | ||
[--config|-c]=[value] | ||
[--help|-h] | ||
[--version|-v] | ||
``` | ||
|
||
**Usage**: | ||
|
||
``` | ||
duocli [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...] | ||
``` | ||
|
||
# GLOBAL OPTIONS | ||
|
||
**--config, -c**="": load configuration from JSON `FILE` | ||
|
||
**--help, -h**: show help | ||
|
||
**--version, -v**: print the version | ||
|
||
|
||
# COMMANDS | ||
|
||
## user | ||
|
||
manage users | ||
|
||
### add | ||
|
||
add a user | ||
|
||
**--email, -e**="": email address of user | ||
|
||
**--firstName, -f**="": first name of user | ||
|
||
**--group, -g**="": add user to group, can be specified multiple times to add user to multiple groups | ||
|
||
**--lastName, -l**="": last name of user | ||
|
||
**--status, -s**="": status of user: active, disabled, or bypass (default: active) | ||
|
||
**--username, -u**="": username | ||
|
||
### get | ||
|
||
get one or more users and display as JSON | ||
|
||
**--username, -u**="": username, can be specified multiple times | ||
|
||
### modify | ||
|
||
modify a user's attributes, add or remove group membership | ||
|
||
**--addgroup, -g**="": add user to groups, adds to existing memberships, and can be specified multiple times to add user to multiple groups | ||
|
||
**--delgroup, -G**="": remove user from groups, removes from existing memberships, and can be specified multiple times to remove user from multiple groups | ||
|
||
**--email, -e**="": email address of user | ||
|
||
**--firstName, -f**="": first name of user | ||
|
||
**--lastName, -l**="": last name of user | ||
|
||
**--status, -s**="": status of user: active, disabled, or bypass | ||
|
||
**--username, -u**="": username | ||
|
||
### remove | ||
|
||
remove user and any attached phones | ||
|
||
**--phone, -P**: remove any phones found attached to the user before removing the user | ||
|
||
**--username, -u**="": username, can be specified multiple times |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"ikey": "DIXXXXXXXXXXXXXXXXXX", | ||
"skey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", | ||
"api_host": "api-XXXXXXXX.duosecurity.com" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters