This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
catalog_user.

list_user_groups

list_user_groups()

Gets a list of all existing user groups.

Parameters

None

Returns

typedescription
List[CatalogUserGroup]List of all user groups as user group entity object.

Example

# List user groups
user_groups = sdk.catalog_user.list_user_groups()

print(user_groups)
# [
#    CatalogUserGroup()
#        id='adminGroup',
#        relationships=None
#    ),
#    CatalogUserGroup(id='adminQA1Group',
#        relationships=CatalogUserGroupRelationships(
#           parents=CatalogUserGroupParents(
#               data=[
#                   CatalogUserGroup(
#                        id='adminGroup',
#                        relationships=None
#                    )
#                ]
#            )
#        )
#    )
#    ...
# ]
delete_user_group
get_declarative_user_groups