Users
Manage users.
See Manage Users and UserGroups to learn how user management works in GoodData.
Entity Methods
- create_or_update_user
- get_user
- delete_user
- list_users
- create_user_api_token
- get_user_api_token
- delete_user_api_token
- list_user_api_tokens
Declarative Methods
- get_declarative_users
- put_declarative_users
- store_declarative_users
- load_declarative_users
- load_and_put_declarative_users
Example
List, create and delete users:
from gooddata_sdk import GoodDataSdk, CatalogUser
# GoodData base URL, e.g. "https://www.example.com"
host = "https://www.example.com"
# GoodData user token
token = "some_user_token"
sdk = GoodDataSdk.create(host, token)
# List users
users = sdk.catalog_user.list_users()
print(users)
# [
# CatalogUser(
# id='demo2',
# attributes=CatalogUserAttributes(
# firstname='John',
# lastname='Doe',
# email='john.doe@email.com',
# authentication_id='abc'
# ),
# relationships=CatalogUserRelationships(
# user_groups=CatalogUserGroupsData(
# data=[
# CatalogUserGroup(
# id='demoGroup',
# relationships=None
# )
# ]
# )
# )
# ),
# ...
# ]
# Define user
user = CatalogUser.init(user_id="abc", firstname="John", lastname="Doe", email="john.doe@email.com", authentication_id="xyz", user_group_ids=["demoGroup"])
# Create user
sdk.catalog_user.create_or_update_user(user=user)
# Delete user
sdk.catalog_user.delete_user(user_id=user.id)