This documentation is for the unstable version of GoodData, currrently in development.
For stable version, go to the latest stable version of this article.
For stable version, go to the latest stable version of this article.
service.CatalogUserService
Properties
NoneMethods
| Name | Description |
|---|---|
| create_or_update_user(user: CatalogUser) | Creates a new user or overwrites an existing user. |
| get_user(user_id: str) | Get an individual user using User id. |
| delete_user(user_id: str) | Delete User using User id. |
| list_users() | Get a list of all existing users. |
| create_or_update_user_group(user_group: CatalogUserGroup) | Create a new user group or overwrite an existing user group. |
| get_user_group(user_group_id: str) | Get an individual user group using user group id. |
| delete_user_group(user_group_id: str) | Delete User Group using User Group id. |
| list_user_groups() | Get a list of all existing user groups. |
| get_declarative_users() | Retrieve all users in a declarative form. |
| put_declarative_users(users: CatalogDeclarativeUsers) | Set all users and their authentication properties. |
| store_declarative_users(layout_root_path: Path) | Store users in directory hierarchy. Directly from server. |
| load_declarative_users(layout_root_path: Path) | Load declarative users layout, which was stored using store_declarative_users. |
| load_and_put_declarative_users(layout_root_path: Path) | Loads and sets the layouts stored using store_declarative_users. |
| get_declarative_user_groups() | Retrieve all user groups in a declarative form. |
| put_declarative_user_groups(user_groups: CatalogDeclarativeUserGroups) | Set all user groups eventually with their parents. |
| load_declarative_user_groups(layout_root_path: Path) | Load declarative users groups layout, which was stored using store_declarative_user_groups. |
| store_declarative_user_groups(layout_root_path: Path) | Stores all the user groups in a directory hierarchy. |
| load_and_put_declarative_user_groups(layout_root_path: Path) | Loads and sets the layouts stored using store_declarative_users. |
| get_declarative_users_user_groups() | Retrieves all users and user groups in a declarative form. |
| put_declarative_users_user_groups(users_user_groups: CatalogDeclarativeUsersUserGroups) | Set all users and user groups. |
| load_declarative_users_user_groups(layout_root_path: Path) | Load declarative users and user groups layout, which was stored using store_declarative_users_user_groups. |
| store_declarative_users_user_groups(layout_root_path: Path) | Stores all the users and user groups in a directory hierarchy. |
| load_and_put_declarative_users_user_groups(layout_root_path: Path) | Loads and sets the layouts stored using store_declarative_users_user_groups. |
| get_user_permissions(user_id: str) | Get permission assignments for a user. |
| manage_user_permissions(user_id: str, permission_assignments: CatalogPermissionAssignments) | Set permission assignments for a user. |
| get_user_group_permissions(user_group_id: str) | Get permission assignments for a user group. |
| manage_user_group_permissions(user_group_id: str, permission_assignments: CatalogPermissionAssignments) | Set permission assignments for a user group. |
| assign_permissions_bulk(permissions_assignment: CatalogPermissionsAssignment) | Assign permissions in bulk to a users or user groups. |
| revoke_permissions_bulk(permissions_assignment: CatalogPermissionsAssignment) | Revoke permissions in bulk to a users or user groups. |
| list_user_api_tokens() | None |
| create_user_api_token() | None |
| get_user_api_token() | None |
| delete_user_api_token() | None |