`flywheel.api.groups_api`

`GroupsApi`

Bases: object

`add_group(body, **kwargs)`

Add a group

Create a new group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GroupInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_permission(group_id, body, **kwargs)`

Add a permission

Adds permission to the group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`AccessPermission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_permission_template(group_id, body, **kwargs)`

Add a permission template

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`RolePermission`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_permission_template_with_http_info(group_id, body, **kwargs)`

Add a permission template

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`RolePermission`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_permission_with_http_info(group_id, body, **kwargs)`

Add a permission

Adds permission to the group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`AccessPermission`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_tag(cid, body, **kwargs)`

Add a tag to a(n) group.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_tag_with_http_info(cid, body, **kwargs)`

Add a tag to a(n) group.

Propagates changes to projects, sessions and acquisitions This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_tags(cid, body, **kwargs)`

Add multiple tags to a(n) group

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_tags_with_http_info(cid, body, **kwargs)`

Add multiple tags to a(n) group

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_group_with_http_info(body, **kwargs)`

Add a group

Create a new group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`body`	`GroupInput`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_role_to_group(group_id, body, **kwargs)`

Add a role to the pool of roles in a group

Add a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`GroupRole`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`add_role_to_group_with_http_info(group_id, body, **kwargs)`

Add a role to the pool of roles in a group

Add a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`GroupRole`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group(group_id, **kwargs)`

Delete group

Delete a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_tag(cid, value, **kwargs)`

Delete a tag

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_tag_with_http_info(cid, value, **kwargs)`

Delete a tag

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_tags(cid, body, **kwargs)`

Delete multiple tags from a(n) group

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_tags_with_http_info(cid, body, **kwargs)`

Delete multiple tags from a(n) group

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`body`	`list[str]`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_user_permission(group_id, user_id, **kwargs)`

Delete a permission

Deletes a permission from the group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_user_permission_template(group_id, user_id, **kwargs)`

Delete a permission

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_user_permission_template_with_http_info(group_id, user_id, **kwargs)`

Delete a permission

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_user_permission_with_http_info(group_id, user_id, **kwargs)`

Delete a permission

Deletes a permission from the group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`delete_group_with_http_info(group_id, **kwargs)`

Delete group

Delete a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_group_roles(group_id, **kwargs)`

Get list of group roles

Gets all group roles. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_group_roles_with_http_info(group_id, **kwargs)`

Get list of group roles

Gets all group roles. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_groups(**kwargs)`

List all groups

Find all groups. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`exhaustive`	`(bool, optional)`	Set to return a complete list regardless of permissions, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_all_groups_with_http_info(**kwargs)`

List all groups

Find all groups. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`exhaustive`	`(bool, optional)`	Set to return a complete list regardless of permissions, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group(group_id, **kwargs)`

Get group info

Get a group by ID. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_projects(group_id, **kwargs)`

Get all projects in a group

Get projects for a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`exhaustive`	`(bool, optional)`	, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_projects_with_http_info(group_id, **kwargs)`

Get all projects in a group

Get projects for a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`exhaustive`	`(bool, optional)`	, defaults to false	required
`include_all_info`	`(bool, optional)`	Include all info in returned objects, defaults to false	required
`filter`	`(str, optional)`	Comma separated filters to apply. Commas not used as separators must be escaped with backslash '\'. (e.g. label=my-label,created>2018-09-22)	required
`sort`	`(str, optional)`	The sort fields and order. (e.g. label:asc,created:desc)	required
`limit`	`(int, optional)`	The maximum number of entries to return.	required
`skip`	`(int, optional)`	The number of entries to skip., defaults to 0	required
`page`	`(int, optional)`	The page number (i.e. skip limit*page entries)	required
`after_id`	`(str, optional)`	Paginate after the given id. (Cannot be used with sort, page or skip)	required
`x_accept_feature`	`(list[str], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_role(group_id, role_id, **kwargs)`

Return the role identified by the RoleId

Get a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`role_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_role_with_http_info(group_id, role_id, **kwargs)`

Return the role identified by the RoleId

Get a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`role_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_tag(cid, value, **kwargs)`

Get the value of a tag, by name.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_tag_with_http_info(cid, value, **kwargs)`

Get the value of a tag, by name.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_user_permission(group_id, user_id, **kwargs)`

List a user's permissions for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_user_permission_template(group_id, user_id, **kwargs)`

List a user's permissions for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_user_permission_template_with_http_info(group_id, user_id, **kwargs)`

List a user's permissions for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_user_permission_with_http_info(group_id, user_id, **kwargs)`

List a user's permissions for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`get_group_with_http_info(group_id, **kwargs)`

Get group info

Get a group by ID. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group(group_id, body, **kwargs)`

Update group

Modify a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`GroupUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group_user_permission(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`body`	`AccessPermissionUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group_user_permission_template(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`body`	`RolePermissionUpdate`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group_user_permission_template_with_http_info(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`body`	`RolePermissionUpdate`		required
`propagate`	`(bool, optional)`	, defaults to false	required
`x_accept_feature`	`(list[union[HeaderFeature, str]], optional)`	, defaults to []	required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group_user_permission_with_http_info(group_id, user_id, body, **kwargs)`

Update a user's permission for this group.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`user_id`	`str`		required
`body`	`AccessPermissionUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`modify_group_with_http_info(group_id, body, **kwargs)`

Update group

Modify a group. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`body`	`GroupUpdate`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`remove_role_from_group(group_id, role_id, **kwargs)`

Remove the role from the group

Delete a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`role_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`remove_role_from_group_with_http_info(group_id, role_id, **kwargs)`

Remove the role from the group

Delete a group role. This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`group_id`	`str`		required
`role_id`	`str`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`rename_group_tag(cid, value, body, **kwargs)`

Rename a tag.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required

`rename_group_tag_with_http_info(cid, value, body, **kwargs)`

Rename a tag.

This method makes a synchronous HTTP request by default.

Parameters:

Name	Type	Description	Default
`cid`	`str`		required
`value`	`str`	The tag to interact with	required
`body`	`Tag`		required
`async_`	`(bool, optional)`	Perform the request asynchronously	required