Skip to content

Commit 7babcc5

Browse files
updating documentation
1 parent 5efa647 commit 7babcc5

File tree

3 files changed

+33
-12
lines changed

3 files changed

+33
-12
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,4 @@ dist/*
1515
.cache
1616
.idea
1717
.pytest_cache/*
18+
slcli

docs/cli/users.rst

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ Users
44
=============
55
Version 5.6.0 introduces the ability to interact with user accounts from the cli.
66

7+
.. _cli_user_create:
8+
user create
9+
-----------
10+
This command will create a user on your account.
11+
12+
Options
13+
^^^^^^^
14+
-e, --email TEXT Email address for this user. Required for creation. [required]
15+
-p, --password TEXT Password to set for this user. If no password is provided, user will be sent an email to generate one, which expires in 24 hours. '-p generate' will create a password for you (Requires Python 3.6+). Passwords require 8+ characters, upper and lowercase, a number and a symbol.
16+
-u, --from-user TEXT Base user to use as a template for creating this user. Will default to the user running this command. Information provided in --template supersedes this template.
17+
-t, --template TEXT A json string describing https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
18+
-a, --api-key Create an API key for this user.
19+
-h, --help Show this message and exit.
20+
21+
::
22+
slcli user create my@email.com -e my@email.com -p generate -a -t '{"firstName": "Test", "lastName": "Testerson"}'
23+
724
.. _cli_user_list:
825

926
user list
@@ -20,7 +37,7 @@ Gives a variety of details about a specific user. <user> can be a user id, or us
2037

2138
user detail <user> -p, --permissions
2239
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
23-
Will list the permissions the user has. To see a list of all possible permissions, or to change a users permissions, see :ref:`cli_user_permissions`
40+
Will list the permissions the user has. To see a list of all possible permissions, or to change a user's permissions, see :ref:`cli_user_permissions`
2441

2542
user detail <user> -h, --hardware
2643
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -62,5 +79,19 @@ Enable or Disable specific permissions. It is possible to set multiple permissio
6279

6380
Will enable TICKET_EDIT, TICKET_ADD, and TICKET_SEARCH permissions for the USERID
6481

82+
.. _cli_user_edit_details:
83+
84+
user edit-details
85+
-----------------
86+
Edit a User's details
87+
88+
JSON strings should be enclosed in '' and each item should be enclosed in ""
89+
90+
::
91+
slcli user edit-details testUser -t '{"firstName": "Test", "lastName": "Testerson"}'
6592

93+
Options
94+
^^^^^^^
95+
-t, --template TEXT A json string describing https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/ [required]
96+
-h, --help Show this message and exit.
6697

slcli

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)