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_users

list_users()

Gets a list of all existing users.

Parameters

None

Returns

typedescription
List[CatalogUser]List of all Users as User entity objects.

Example

# List users
users = sdk.catalog_user.list_users()

print(users)
# [
#   CatalogUser(
#       id='demo2',
#       attributes=CatalogUserAttributes(
#            authentication_id='abc'
#       ),
#       relationships=CatalogUserRelationships(
#           user_groups=CatalogUserGroupsData(
#               data=[
#                   CatalogUserGroup(
#                       id='demoGroup',
#                       relationships=None
#                   )
#               ]
#           )
#       )
#  ),
#   ...
# ]