# group ## group add-user **Usage** ```none usage: symp group add-user [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id user_id ``` **Description** Adds the specified user to the specified group. **Mandatory** ```none positional arguments: group_id The id of the group to update user_id The id of the user to add ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group attach-aws-policy **Usage** ```none usage: symp group attach-aws-policy [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id policy_id project_id ``` **Description** Attaches the specified AWS policy to the specified group. **Mandatory** ```none positional arguments: group_id The ID of the group to attach the policy to policy_id The ID of the policy you want to attach project_id The ID of the project in which to attach the policy ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group attach-strato-policy **Usage** ```none usage: symp group attach-strato-policy [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id policy_id project_id ``` **Description** Attaches the specified Strato policy to the specified group. **Mandatory** ```none positional arguments: group_id The ID of the group to attach the policy to policy_id The ID of the policy you want to attach project_id The ID of the project in which to attach the policy ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group create **Usage** ```none usage: symp group create [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--path PATH] [--domain-id DOMAIN_ID] name ``` **Description** Creates a new group. **Returns** Returns dict: A structure containing details about the new group **Mandatory** ```none positional arguments: name The name of the group to create ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --path PATH The path to the group --domain-id DOMAIN_ID The domain in which to create the group. If not supplied, creating in current domain ``` ## group detach-aws-policy **Usage** ```none usage: symp group detach-aws-policy [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id policy_id project_id ``` **Description** Removes the specified AWS policy from the specified group. **Mandatory** ```none positional arguments: group_id The ID of the group to detach the policy from policy_id The ID of the policy you want to detach project_id The ID of the project in which to detach the policy ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group detach-strato-policy **Usage** ```none usage: symp group detach-strato-policy [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id policy_id project_id ``` **Description** Removes the specified Strato policy from the specified group. **Mandatory** ```none positional arguments: group_id The ID of the group to detach the policy from policy_id The ID of the policy you want to detach project_id The ID of the project in which to detach the policy ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group get **Usage** ```none usage: symp group get [-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id ``` **Description** Get information of a group. **Returns** Returns dict: Information of group **Mandatory** ```none positional arguments: group_id ID of group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group list **Usage** ```none usage: symp group list [-h] [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] [--domain-id DOMAIN_ID] [--name NAME] ``` **Description** List all groups. **Returns** Returns list: List of groups **Optional** ```none optional arguments: -h, --help show this help message and exit --domain-id DOMAIN_ID Filter by a specific domain ID. None means show current domain for tenant-admins, and all domains for system admins --name NAME Only list groups with the given name ``` ## group list-aws-policies **Usage** ```none usage: symp group list-aws-policies [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] group_id project_id ``` **Description** Lists all AWS policies that are attached to the specified group. **Returns** Returns list: List of the AWS policies that are attached to the specified group **Mandatory** ```none positional arguments: group_id The ID of the group to list attached policies for project_id The ID of the project in which the policies are attached ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group list-strato-policies **Usage** ```none usage: symp group list-strato-policies [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] group_id project_id ``` **Description** Lists all Strato policies that are attached to the specified group. **Returns** Returns list: List of the Strato policies that are attached to the specified group **Mandatory** ```none positional arguments: group_id The ID of the group to list attached policies for project_id The ID of the project in which the policies are attached ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group list-users **Usage** ```none usage: symp group list-users [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--quote {all,minimal,none,nonnumeric}] [-m [NAME=VALUE [NAME=VALUE ...]]] [--sort-column SORT_COLUMN] group_id ``` **Description** Returns a list of users that are in the specified group. **Returns** Returns list: List of users in the group **Mandatory** ```none positional arguments: group_id The id of the group ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group remove **Usage** ```none usage: symp group remove [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id ``` **Description** Deletes the specified group. **Mandatory** ```none positional arguments: group_id The id of the group to delete ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group remove-user **Usage** ```none usage: symp group remove-user [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id user_id ``` **Description** Removes the specified user from the specified group. **Mandatory** ```none positional arguments: group_id The id of the group to update user_id The id of the user to remove ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group set-aws-policies **Usage** ```none usage: symp group set-aws-policies [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id --policy_ids [--policy_ids ...] project_id ``` **Description** Set the group’s AWS policies in the specified project. **Mandatory** ```none positional arguments: group_id The ID of the group to attach the policies to --policy_ids The IDs of the policies you want to attach project_id The ID of the project in which to attach the policies ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group set-strato-policies **Usage** ```none usage: symp group set-strato-policies [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] group_id --policy_ids [--policy_ids ...] project_id ``` **Description** Set the group’s Strato policies in the specified project. **Mandatory** ```none positional arguments: group_id The ID of the group to attach the policy to --policy_ids The IDs of the policies you want to attach project_id The ID of the project in which to attach the policy ``` **Optional** ```none optional arguments: -h, --help show this help message and exit ``` ## group update **Usage** ```none usage: symp group update [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width ] [--fit-width] [--print-empty] [--noindent] [--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]] [--new-name NEW_NAME] [--new-path NEW_PATH] group_id ``` **Description** Updates the name and/or the path of the specified group. **Returns** Returns dict: A structure containing details about the group **Mandatory** ```none positional arguments: group_id ID of the group to update ``` **Optional** ```none optional arguments: -h, --help show this help message and exit --new-name NEW_NAME New name for the group. Only include this if changing the group's name --new-path NEW_PATH New path for the group. Only include this if changing the group's path ```