user¶
user attach-aws-policy¶
Usage
usage: symp user attach-aws-policy
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id policy_id project_id
Description
Attaches the specified AWS policy to the specified user.
Mandatory
positional arguments:
user_id The ID of the user to attach the policy to
policy_id The name of the policy to attach
project_id The ID of the project in which to attach the policy
Optional
optional arguments:
-h, --help show this help message and exit
user attach-strato-policy¶
Usage
usage: symp user attach-strato-policy
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id policy_id project_id
Description
Attaches the specified Strato policy to the specified user.
Mandatory
positional arguments:
user_id The ID of the user to attach the policy to
policy_id The ID of the policy to attach
project_id The ID of the project in which to attach the policy
Optional
optional arguments:
-h, --help show this help message and exit
user change-password¶
Usage
usage: symp user change-password
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
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.
Mandatory
positional arguments:
original_password The old password
password The new password to set for the user
Optional
optional arguments:
-h, --help show this help message and exit
user create¶
Usage
usage: symp user create
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--email EMAIL] [--enabled] [--domain-id DOMAIN_ID]
[--path PATH] [--must-change-password]
[--external-id EXTERNAL_ID]
project_id name password
Description
Create a new user.
Returns
Returns dict: Details of created user
Mandatory
positional arguments:
project_id A project ID the user will be assigned to
name Name of user
password Password for 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 next login)
--external-id EXTERNAL_ID
External id
user create-ec2-credentials¶
Usage
usage: symp user create-ec2-credentials
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--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.
Returns
Returns dict: The new credentials
Mandatory
positional arguments:
user_id ID of user
project_id ID of project
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: symp user detach-aws-policy
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id policy_id project_id
Description
Removes the specified AWS policy from the specified user.
Mandatory
positional arguments:
user_id The ID of the user to detach the policy from
policy_id The ID of the policy to detach
project_id The ID of the project in which to detach the policy
Optional
optional arguments:
-h, --help show this help message and exit
user detach-strato-policy¶
Usage
usage: symp user detach-strato-policy
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id policy_id project_id
Description
Removes the specified Strato policy from the specified user.
Mandatory
positional arguments:
user_id The ID of the user to detach the policy from
policy_id The ID of the policy to detach
project_id The ID of the project in which to detach the policy
Optional
optional arguments:
-h, --help show this help message and exit
user get¶
Usage
usage: symp user get
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
user_id
Description
Get information of a user.
Returns
Returns dict: Information of user
Mandatory
positional arguments:
user_id ID of user
Optional
optional arguments:
-h, --help show this help message and exit
user get-my-details¶
Usage
usage: symp user get-my-details
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
Returns details of currently logged-in user.
Returns
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: symp user list
[-h] [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--domain-id DOMAIN_ID] [--name NAME]
[--project-id PROJECT_ID] [--group-id GROUP_ID]
[--external-id EXTERNAL_ID]
Description
Get list of users.
Returns
Returns list: List of users
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
--external-id EXTERNAL_ID
Filter by external id
user list-aws-policies¶
Usage
usage: symp user list-aws-policies
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id project_id
Description
Lists all AWS policies that are attached to the specified user.
Returns
Returns list: List of the AWS policies that are attached to the specified user
Mandatory
positional arguments:
user_id The ID of the user to list attached policies for
project_id The ID of the project in which the policies are attached
Optional
optional arguments:
-h, --help show this help message and exit
user list-ec2-credentials¶
Usage
usage: symp user list-ec2-credentials
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--project-id PROJECT_ID]
user_id
Description
Lists the given user ec2 credentials.
Returns
Returns list: List of user’s credentials
Mandatory
positional arguments:
user_id ID of user
Optional
optional arguments:
-h, --help show this help message and exit
--project-id PROJECT_ID
If given, will only return credentials for the given project
user list-groups¶
Usage
usage: symp user list-groups
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id
Description
Lists the groups that the specified user belongs to.
Returns
Returns list: List of the groups that the user belongs to
Mandatory
positional arguments:
user_id The ID of the user to list attached groups for
Optional
optional arguments:
-h, --help show this help message and exit
user list-strato-policies¶
Usage
usage: symp user list-strato-policies
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id project_id
Description
Lists all Strato policies that are attached to the specified user.
Returns
Returns list: List of the Strato policies that are attached to the specified user
Mandatory
positional arguments:
user_id The ID of the user to list attached policies for
project_id The ID of the project in which the policies are attached
Optional
optional arguments:
-h, --help show this help message and exit
user list-user-projects¶
Usage
usage: symp user list-user-projects
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
Description
List projects a user can login to, in all domains.
Returns
Returns list: Projects user can login to
Optional
optional arguments:
-h, --help show this help message and exit
user multi-factor-auth disable¶
Usage
usage: symp user multi-factor-auth disable
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--passcode PASSCODE]
[--user-id USER_ID]
Description
Removes Mutli-Factor Authentication and deletes TOTP credentials on the given user.
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: symp user multi-factor-auth enable
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--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.
Returns
Returns str: The TOTP secret
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: symp user multi-factor-auth verify
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--user-id USER_ID]
passcode
Description
Validates a TOTP passcode and enable Multi-Factor Authentication.
Mandatory
positional arguments:
passcode The TOTP passcode derived from a TOTP secret received from set_mfa
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: symp user remove
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
user_id
Description
Remove a user from the system.
Mandatory
positional arguments:
user_id ID of user to remove
Optional
optional arguments:
-h, --help show this help message and exit
user remove-ec2-credentials¶
Usage
usage: symp user remove-ec2-credentials
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id credential_id
Description
Deletes and expires an EC2 credential pair.
Mandatory
positional arguments:
user_id ID of user
credential_id The access-id of the credential to remove
Optional
optional arguments:
-h, --help show this help message and exit
user set-aws-policies¶
Usage
usage: symp user set-aws-policies
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id --policy_ids [--policy_ids ...]
project_id
Description
Set the user’s AWS policies in the specified project.
Mandatory
positional arguments:
user_id The ID of the user to attach the policy to
--policy_ids The IDs of the policies to attach
project_id The ID of the project in which to attach the policy
Optional
optional arguments:
-h, --help show this help message and exit
user set-strato-policies¶
Usage
usage: symp user set-strato-policies
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
user_id --policy_ids [--policy_ids ...]
project_id
Description
Set the user’s Strato policies in the specified project.
Mandatory
positional arguments:
user_id The ID of the user to attach the policies to
--policy_ids The IDs of the policies to attach
project_id The ID of the project in which to attach the policies
Optional
optional arguments:
-h, --help show this help message and exit
user update¶
Usage
usage: symp user update
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
[--project PROJECT] [--name NAME]
[--password PASSWORD] [--email EMAIL]
[--enabled ENABLED] [--path PATH]
[--password-never-expires PASSWORD_NEVER_EXPIRES]
[--must-change-password MUST_CHANGE_PASSWORD]
[--external-id EXTERNAL_ID]
user_id
Description
Update user data.
Returns
Returns dict: The new user information
Mandatory
positional arguments:
user_id ID of user
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 MUST_CHANGE_PASSWORD
Set password for single use (force user to change it on next login)
If this parameter is not provided, the default is True
--external-id EXTERNAL_ID
External id