Users¶
Version 5.6.0 introduces the ability to interact with user accounts from the cli.
user list¶
List Users.
user list [OPTIONS]
Options
- --columns <columns>¶
Columns to display. [options: id, username, email, displayName, status, hardwareCount, virtualGuestCount, 2FA, classicAPIKey]
- Default
id,username,email,displayName,2FA,classicAPIKey
user detail¶
User details.
user detail [OPTIONS] IDENTIFIER
Options
- -k, --keys¶
Show the users API key.
- -p, --permissions¶
Display permissions assigned to this user. Master users will show no permissions
- -h, --hardware¶
Display hardware this user has access to.
- -v, --virtual¶
Display virtual guests this user has access to.
- -l, --logins¶
Show login history of this user for the last 30 days
- -e, --events¶
Show event log for this user.
Arguments
- IDENTIFIER¶
Required argument
user notifications¶
My Notifications.
user notifications [OPTIONS]
user permissions¶
User Permissions.
user permissions [OPTIONS] IDENTIFIER
Arguments
- IDENTIFIER¶
Required argument
user edit-notifications¶
Enable or Disable specific notifications for the active user.
Notification names should be enclosed in quotation marks. Example:
slcli user edit-notifications --enable 'Order Approved' 'Reload Complete'
user edit-notifications [OPTIONS] NOTIFICATION...
Options
- --enable, --disable¶
Enable (DEFAULT) or Disable selected notification
Arguments
- NOTIFICATION¶
Required argument(s)
user edit-permissions¶
Enable or Disable specific permissions.
user edit-permissions [OPTIONS] IDENTIFIER
Options
- --enable, --disable¶
Enable (DEFAULT) or Disable selected permissions
- -p, --permission <permission>¶
Permission keyName to set, multiple instances allowed. Use keyword ALL to select ALL permisssions
- -u, --from-user <from_user>¶
Set permissions to match this user’s permissions. Will add then remove the appropriate permissions
Arguments
- IDENTIFIER¶
Required argument
user edit-details¶
Edit a Users details
JSON strings should be enclosed in ‘’ and each item should be enclosed in “”
Example:
slcli user edit-details testUser -t '{"firstName": "Test", "lastName": "Testerson"}'
user edit-details [OPTIONS] USER
Options
- -t, --template <template>¶
Required A json string describing https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
Arguments
- USER¶
Required argument
user create¶
Creates a user Users.
Remember to set the permissions and access for this new user.
Example:
slcli user create my@email.com -e my@email.com -p generate -a
-t '{"firstName": "Test", "lastName": "Testerson"}'
user create [OPTIONS] USERNAME
Options
- -e, --email <email>¶
Required Email address for this user. Required for creation.
- -p, --password <password>¶
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.
- -u, --from-user <from_user>¶
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.
- -t, --template <template>¶
A json string describing https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
Arguments
- USERNAME¶
Required argument
user delete¶
Sets a user’s status to CANCEL_PENDING, which will immediately disable the account,
and will eventually be fully removed from the account by an automated internal process.
Example: slcli user delete userId
user delete [OPTIONS] IDENTIFIER
Arguments
- IDENTIFIER¶
Required argument
user device-access¶
User Device access.
user device-access [OPTIONS] IDENTIFIER
Arguments
- IDENTIFIER¶
Required argument
user vpn-manual¶
Enable or disable user vpn subnets manual config
user vpn-manual [OPTIONS] USER
Options
- --enable, --disable¶
Enable or disable vpn subnets manual config.
Arguments
- USER¶
Required argument
user vpn-subnet¶
Add or remove subnets access for a user.
user vpn-subnet [OPTIONS] USER SUBNET...
Options
- --add, --remove¶
Add or remove access to subnets.
Arguments
- USER¶
Required argument
- SUBNET¶
Required argument(s)
user remove-access¶
Removes a user access to a given device.
Example: slcli user remove-access 123456 –hardware 123456789
user remove-access [OPTIONS] IDENTIFIER
Options
- --hardware <hardware>¶
Hardware ID
- --virtual <virtual>¶
Virtual Guest ID
- --dedicated <dedicated>¶
Dedicated host ID
Arguments
- IDENTIFIER¶
Required argument
user grant-access¶
Grants a user access to a given device.
Example: slcli user grant-access 123456 –hardware 123456789
user grant-access [OPTIONS] IDENTIFIER
Options
- --hardware <hardware>¶
Hardware ID
- --virtual <virtual>¶
Virtual Guest ID
- --dedicated <dedicated>¶
dedicated host ID
Arguments
- IDENTIFIER¶
Required argument
user vpn-password¶
Set the user VPN password.
Example: slcli user vpn-password 123456 –password=Mypassword1.
user vpn-password [OPTIONS] IDENTIFIER
Options
- --password <password>¶
Required Your new VPN password
Arguments
- IDENTIFIER¶
Required argument
user apikey¶
Allows to create, remove or refresh user’s API authentication key.
Each user can only have a single API key.
user apikey [OPTIONS] IDENTIFIER
Options
- --add¶
Create an user’s API authentication key.
- --remove¶
Remove an user’s API authentication key.
- --refresh¶
Refresh an user’s API authentication key.
Arguments
- IDENTIFIER¶
Required argument