Draft: Add user management methods to py-client integration page #563
Conversation
src/dev/integration.md
Outdated
| @@ -40,24 +40,24 @@ client.create_user(<email>, <password>, <workspace_id>, <workspace_role>, [usern | |||
| ``` | |||
| Arguments: | |||
| `email` (str): Must be a unique email | |||
| `passowrd` (str): Must meet security requirements. | |||
| `passoword` (str): Must meet security requirements. | |||
| ``` | ||
|
|
||
| #### User and roles management |
There was a problem hiding this comment.
Is this relevant only to the Python module or also to the Python command line interface? If both, this should be a subsection (### User and role management) and moved below the Python CLI subsection,
The #### level of subsection is in my opinion the last subsection level that looks okay. ##### subsections (that are used here) do not look very good when the page is compiled, so I would avoid using them. If it's necessary to structure the page this way, I would considering making separate pages for Python integration and C++ integration (to remove one level of subsections).
There was a problem hiding this comment.
Hmm.. the new commands are available only in the Python module so far. It'll be added to the CLI soon but the syntax is different anyway.
As the content will grow, the dedicated pages make sense.
| client.create_user(<email>, <password>, <workspace_id>, <workspace_role>, [username], [notify_user]) | ||
| ``` | ||
| Arguments: | ||
| `email` (str): Must be a unique email |
There was a problem hiding this comment.
Could we try some other description instead of "unique email"? Maybe something like: "an email that is not yet used on the server" or "email not yet associated with an account"
Also, I would considering writing the data types in full (i.e. string, integer, etc.) to be consistent with this for instance.
There was a problem hiding this comment.
1, sure - unique email is confusing, indeed
2, shall we put the arguments in the table like in the link?
There was a problem hiding this comment.
Thank you @harminius for preparing the skeleton! 💪🏻 We will take it from here with @alex-cit
There was a problem hiding this comment.
We should add a comment here for our CE users what they need to do to use this API
| `workspace_id` (int): The workspace ID where the user will be added. | ||
| `workspace_role`(str): The user’s role in the workspace. [See the roles options](../manage/permissions.md) | ||
| `username` (str, optional): Custom username; autogenerated if not provided. | ||
| `notify_user` (bool, optional): Flag for email notifications (invitations, access requests etc.). Default is `False` |
There was a problem hiding this comment.
| `notify_user` (bool, optional): Flag for email notifications (invitations, access requests etc.). Default is `False` | |
| `notify_user` (bool, optional): Sends a confirmation email to the `email` address and enables email communication for the new account (invitation emails, access request emails and more). Default is `False`. |
Resolves #553
Describe new possibilities of the python client:
User creation
create_userProjects API
list_project_collaboratorsadd_project_collaboratorupdate_project_collaboratorremove_project_collaboratorWorkspaces API
list_workspace_membersget_workspace_memberupdate_workspace_memberremove_workspace_member