user¶
user attach-aws-policy¶
Usage
usage: -c user attach-aws-policy [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id policy_id project_id
Description
Attaches the specified AWS policy to the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user attach-strato-policy¶
Usage
usage: -c user attach-strato-policy [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id policy_id project_id
Description
Attaches the specified Strato policy to the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user change-password¶
Usage
usage: -c user change-password [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
original_password password
Description
An API for a user to change their own password. http://developer.openstack.org/api-ref-identity-v3.html#changeUserPassword Password can also be changed using “update user” api, but only admin can use that. This is for a user to change their own password.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user create¶
Usage
usage: -c user create [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--email EMAIL] [--enabled] [--domain-id DOMAIN_ID]
[--path PATH] [--must-change-password]
project_id name password
Description
Create a new user.
Return
Returns dict: Details of created user
Optional
optional arguments:
-h, --help show this help message and exit
--email EMAIL Email of user
--enabled Is user enabled
--domain-id DOMAIN_ID
User's domain, also user is granted member role in this domain
--path PATH The path for the user name
--must-change-password
Set password for single use (force user to change it on first login)
user create-ec2-credentials¶
Usage
usage: -c user create-ec2-credentials [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--access-key-id ACCESS_KEY_ID]
[--secret-access-key SECRET_ACCESS_KEY]
user_id project_id
Description
Creates EC2 credentials for given user ID in desired project.
Return
Returns dict: The new credentials
Optional
optional arguments:
-h, --help show this help message and exit
--access-key-id ACCESS_KEY_ID
Pre-generated access key. If not given, one will be generated
--secret-access-key SECRET_ACCESS_KEY
Pre-generated secret access key. Must be given if access_key_id is not None.
If not given, one will be generated
user detach-aws-policy¶
Usage
usage: -c user detach-aws-policy [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id policy_id project_id
Description
Removes the specified AWS policy from the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user detach-strato-policy¶
Usage
usage: -c user detach-strato-policy [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id policy_id project_id
Description
Removes the specified Strato policy from the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user get¶
Usage
usage: -c user get [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
user_id
Description
Get information of a user.
Return
Returns dict: Information of user
Optional
optional arguments:
-h, --help show this help message and exit
user get-my-details¶
Usage
usage: -c user get-my-details [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
Description
Returns details of currently logged-in user.
Return
Returns dict: User, project, and domain info for current log in
Optional
optional arguments:
-h, --help show this help message and exit
user list¶
Usage
usage: -c user list [-h] [-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--domain-id DOMAIN_ID] [--name NAME]
[--project-id PROJECT_ID] [--group-id GROUP_ID]
Description
Get list of users.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--domain-id DOMAIN_ID
Filters by a domain ID
--name NAME Filters by a user name
--project-id PROJECT_ID
Filter by domain of a certain project. deprecated
--group-id GROUP_ID Filters by a group ID
user list-aws-policies¶
Usage
usage: -c user list-aws-policies [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
user_id project_id
Description
Lists all AWS policies that are attached to the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user list-ec2-credentials¶
Usage
usage: -c user list-ec2-credentials [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[--show-secret] [--project-id PROJECT_ID]
user_id
Description
Lists the given user ec2 credentials.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--show-secret When True, includes the secret in the result
--project-id PROJECT_ID
If given, will only return credentials for the given project
user list-groups¶
Usage
usage: -c user list-groups [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
user_id
Description
Lists the groups that the specified user belongs to.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user list-strato-policies¶
Usage
usage: -c user list-strato-policies [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
user_id project_id
Description
Lists all Strato policies that are attached to the specified user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user list-user-projects¶
Usage
usage: -c user list-user-projects [-h]
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
Description
List projects a user can login to, in all domains.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user multi-factor-auth disable¶
Usage
usage: -c user multi-factor-auth disable [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
[--passcode PASSCODE]
[--user-id USER_ID]
Description
Removes Mutli-Factor Authentication and deletes TOTP credentials on the given user.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--passcode PASSCODE The TOTP passcode derived from a TOTP secret, this is required if called by a non-admin user
--user-id USER_ID ID of the user, if omitted, action will be performed on the authenticated user
user multi-factor-auth enable¶
Usage
usage: -c user multi-factor-auth enable [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--user-id USER_ID]
Description
Creates a TOTP secret to be used for Multi-Factor Authentication. MFA won’t be enabled until verifying with multi-factor-auth verify.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--user-id USER_ID ID of the user, if omitted, action will be performed on the authenticated user
user multi-factor-auth verify¶
Usage
usage: -c user multi-factor-auth verify [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX] [--user-id USER_ID]
passcode
Description
Validates a TOTP passcode and enable Multi-Factor Authentication.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
--user-id USER_ID ID of the user, if omitted, action will be performed on the authenticated user
user remove¶
Usage
usage: -c user remove [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
user_id
Description
Remove a user from the system.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user remove-ec2-credentials¶
Usage
usage: -c user remove-ec2-credentials [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id credential_id
Description
Deletes and expires an EC2 credential pair.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user set-aws-policies¶
Usage
usage: -c user set-aws-policies [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id --policy_ids [--policy_ids ...]
project_id
Description
Set the user’s AWS policies in the specified project.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user set-strato-policies¶
Usage
usage: -c user set-strato-policies [-h]
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent]
[--prefix PREFIX]
user_id --policy_ids [--policy_ids ...]
project_id
Description
Set the user’s Strato policies in the specified project.
Return
None
Optional
optional arguments:
-h, --help show this help message and exit
user update¶
Usage
usage: -c user update [-h] [-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--max-width <integer>] [--noindent] [--prefix PREFIX]
[--project PROJECT] [--name NAME] [--password PASSWORD]
[--email EMAIL] [--enabled ENABLED] [--path PATH]
[--password-never-expires PASSWORD_NEVER_EXPIRES]
[--must-change-password]
user_id
Description
Update user data.
Return
Returns dict: The new user information
Optional
optional arguments:
-h, --help show this help message and exit
--project PROJECT New default project
--name NAME New name of user
--password PASSWORD New password for user
--email EMAIL New email of user
--enabled ENABLED New enabled/disabled settings
--path PATH New path for the user
--password-never-expires PASSWORD_NEVER_EXPIRES
Enable/Disable password expiration policy for user
--must-change-password
Set password for single use (force user to change it on first login)