All URIs are relative to https://localhost:8080/api/v9
Method | HTTP request | Description |
---|---|---|
delete_organization_users_leave | DELETE /organizations/{organization_id}/users/leave | Leaves organization |
delete_workspace_user | DELETE /workspaces/{workspace_id}/workspace_users/{workspace_user_id} | Delete workspace user |
get_organization_users | GET /organizations/{organization_id}/users | List of users in organization |
get_organization_users_detailed | GET /organizations/{organization_id}/users/detailed | List of users in organization with details |
get_organization_workspaces_workspaceusers | GET /organizations/{organization_id}/workspaces/{workspace_id}/workspace_users | List of users who belong to the given workspace. |
get_workspace_users | GET /workspaces/{workspace_id}/users | Get workspace users |
get_workspace_workspace_users | GET /workspaces/{workspace_id}/workspace_users | Get workspace workspace-users |
patch_organization_users | PATCH /organizations/{organization_id}/users | Apply changes in bulk to users in an organization |
patch_organization_workspace_users | PATCH /organizations/{organization_id}/workspaces/{workspace_id}/workspace_users | Changes the users in a workspace. |
post_workspace_users_lost_password | POST /workspaces/{workspace_id}/users/{user_id}/lost_password | Change a lost password |
put_organization_users | PUT /organizations/{organization_id}/users/{organization_user_id} | Changes a single organization-user |
put_organization_workspaces_assignments | PUT /organizations/{organization_id}/workspaces/{workspace_id}/assignments | Change assignments of users within a workspace. |
put_workspace_users | PUT /workspaces/{workspace_id}/users/{user_id} | Update workspace user |
put_workspace_workspace_users | PUT /workspaces/{workspace_id}/workspace_users/{workspace_user_id} | Update workspace-user |
str delete_organization_users_leave(organization_id)
Leaves organization
Leaves organization, effectively delete user account in org and delete organization if it is last user
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
try:
# Leaves organization
api_response = api_instance.delete_organization_users_leave(organization_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->delete_organization_users_leave: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization |
str
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_workspace_user(workspace_id, workspace_user_id)
Delete workspace user
Removes user from workspace
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = toggl.UsersApi()
workspace_id = 56 # int | Numeric ID of the workspace.
workspace_user_id = 56 # int | Numeric ID of the workspace user.
try:
# Delete workspace user
api_instance.delete_workspace_user(workspace_id, workspace_user_id)
except ApiException as e:
print("Exception when calling UsersApi->delete_workspace_user: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace. | |
workspace_user_id | int | Numeric ID of the workspace user. |
void (empty response body)
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[ModelsOrgUser] get_organization_users(organization_id, filter=filter, active_status=active_status, only_admins=only_admins, groups=groups, workspaces=workspaces, page=page, per_page=per_page, sort_dir=sort_dir)
List of users in organization
Returns list of users in organization based on set of url parameters: Result is paginated. Pagination params are returned in headers
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
filter = 'filter_example' # str | Returns records where name or email contains this string (optional)
active_status = 'active_status_example' # str | List of `active` `inactive` `invited` comma separated(if not present, all statuses) (optional)
only_admins = 'only_admins_example' # str | If true returns admins only (optional)
groups = 'groups_example' # str | Comma-separated list of groups ids, returns users belonging to these groups only (optional)
workspaces = 'workspaces_example' # str | Comma-separated list of workspaces ids, returns users belonging to this workspaces only (optional)
page = 56 # int | Page number, default 1 (optional)
per_page = 56 # int | Number of items per page, default 50 (optional)
sort_dir = 'sort_dir_example' # str | Values 'asc' or 'desc', result is sorted on 'names' column, default 'asc' (optional)
try:
# List of users in organization
api_response = api_instance.get_organization_users(organization_id, filter=filter, active_status=active_status, only_admins=only_admins, groups=groups, workspaces=workspaces, page=page, per_page=per_page, sort_dir=sort_dir)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_organization_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
filter | str | Returns records where name or email contains this string | [optional] |
active_status | str | List of `active` `inactive` `invited` comma separated(if not present, all statuses) | [optional] |
only_admins | str | If true returns admins only | [optional] |
groups | str | Comma-separated list of groups ids, returns users belonging to these groups only | [optional] |
workspaces | str | Comma-separated list of workspaces ids, returns users belonging to this workspaces only | [optional] |
page | int | Page number, default 1 | [optional] |
per_page | int | Number of items per page, default 50 | [optional] |
sort_dir | str | Values 'asc' or 'desc', result is sorted on 'names' column, default 'asc' | [optional] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[ModelsOrgUserDetailed] get_organization_users_detailed(organization_id, filter=filter, active_status=active_status, only_admins=only_admins, groups=groups, workspaces=workspaces, page=page, per_page=per_page, sort_dir=sort_dir)
List of users in organization with details
Returns list of users in organization based on set of url parameters: Result is paginated. Pagination params are returned in headers
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
filter = 'filter_example' # str | Returns records where name or email contains this string (optional)
active_status = 'active_status_example' # str | List of `active` `inactive` `invited` comma separated(if not present, all statuses) (optional)
only_admins = 'only_admins_example' # str | If true returns admins only (optional)
groups = 'groups_example' # str | Comma-separated list of groups ids, returns users belonging to these groups only (optional)
workspaces = 'workspaces_example' # str | Comma-separated list of workspaces ids, returns users belonging to this workspaces only (optional)
page = 56 # int | Page number, default 1 (optional)
per_page = 56 # int | Number of items per page, default 50 (optional)
sort_dir = 'sort_dir_example' # str | Values 'asc' or 'desc', result is sorted on 'names' column, default 'asc' (optional)
try:
# List of users in organization with details
api_response = api_instance.get_organization_users_detailed(organization_id, filter=filter, active_status=active_status, only_admins=only_admins, groups=groups, workspaces=workspaces, page=page, per_page=per_page, sort_dir=sort_dir)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_organization_users_detailed: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
filter | str | Returns records where name or email contains this string | [optional] |
active_status | str | List of `active` `inactive` `invited` comma separated(if not present, all statuses) | [optional] |
only_admins | str | If true returns admins only | [optional] |
groups | str | Comma-separated list of groups ids, returns users belonging to these groups only | [optional] |
workspaces | str | Comma-separated list of workspaces ids, returns users belonging to this workspaces only | [optional] |
page | int | Page number, default 1 | [optional] |
per_page | int | Number of items per page, default 50 | [optional] |
sort_dir | str | Values 'asc' or 'desc', result is sorted on 'names' column, default 'asc' | [optional] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[ModelsOrganizationWorkspaceUser] get_organization_workspaces_workspaceusers(organization_id, workspace_id, name)
List of users who belong to the given workspace.
Returns any users who belong to the workspace directly or through at least one group.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
workspace_id = 56 # int | Numeric ID of the workspace within the organization
name = 'name_example' # str | Workspace user name to filter by
try:
# List of users who belong to the given workspace.
api_response = api_instance.get_organization_workspaces_workspaceusers(organization_id, workspace_id, name)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_organization_workspaces_workspaceusers: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
workspace_id | int | Numeric ID of the workspace within the organization | |
name | str | Workspace user name to filter by |
list[ModelsOrganizationWorkspaceUser]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[ModelsSimpleWorkspaceUser] get_workspace_users(workspace_id)
Get workspace users
List all users for a given workspace.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
workspace_id = 56 # int | Numeric ID of the workspace
try:
# Get workspace users
api_response = api_instance.get_workspace_users(workspace_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_workspace_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace |
list[ModelsSimpleWorkspaceUser]
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
list[ModelsWorkspaceUser] get_workspace_workspace_users(workspace_id, include_indirect)
Get workspace workspace-users
List all workspace_users for a given workspace.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
workspace_id = 56 # int | Numeric ID of the workspace
include_indirect = 'include_indirect_example' # str | If true, includes indirect users (i.e. users assigned via group) to workspace user list
try:
# Get workspace workspace-users
api_response = api_instance.get_workspace_workspace_users(workspace_id, include_indirect)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_workspace_workspace_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace | |
include_indirect | str | If true, includes indirect users (i.e. users assigned via group) to workspace user list |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str patch_organization_users(organization_id, params)
Apply changes in bulk to users in an organization
Apply changes in bulk to users in an organization (currently deletion only).
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
params = toggl.UserPatchParams() # UserPatchParams | Input data of the users to be patched.
try:
# Apply changes in bulk to users in an organization
api_response = api_instance.patch_organization_users(organization_id, params)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->patch_organization_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
params | UserPatchParams | Input data of the users to be patched. |
str
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str patch_organization_workspace_users(organization_id, workspace_id, params)
Changes the users in a workspace.
Changes the users in a workspace (currently deletion only).
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
workspace_id = 56 # int | Numeric ID of the workspace
params = toggl.WorkspaceUsersPatchParams() # WorkspaceUsersPatchParams | Input data of the users to be patched.
try:
# Changes the users in a workspace.
api_response = api_instance.patch_organization_workspace_users(organization_id, workspace_id, params)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->patch_organization_workspace_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
workspace_id | int | Numeric ID of the workspace | |
params | WorkspaceUsersPatchParams | Input data of the users to be patched. |
str
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UsersLostPasswordURL post_workspace_users_lost_password(workspace_id, user_id)
Change a lost password
Request a change password action
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
workspace_id = 56 # int | Numeric ID of the workspace
user_id = 56 # int | Numeric ID of the user
try:
# Change a lost password
api_response = api_instance.post_workspace_users_lost_password(workspace_id, user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_workspace_users_lost_password: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace | |
user_id | int | Numeric ID of the user |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str put_organization_users(organization_id, params)
Changes a single organization-user
Changes a single organization-user. Can affect the following values:
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
params = toggl.UserPayload() # UserPayload | Input data of the organization user to be changed.
try:
# Changes a single organization-user
api_response = api_instance.put_organization_users(organization_id, params)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->put_organization_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
params | UserPayload | Input data of the organization user to be changed. |
str
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str put_organization_workspaces_assignments(organization_id, workspace_id, post)
Change assignments of users within a workspace.
Assign or remove users to/from a workspace or to/from groups belonging to said workspace.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
organization_id = 56 # int | Numeric ID of the organization
workspace_id = 56 # int | Numeric ID of the workspace within the organization
post = toggl.UserAssignmentsPayload() # UserAssignmentsPayload | Describes the change in assignment
try:
# Change assignments of users within a workspace.
api_response = api_instance.put_organization_workspaces_assignments(organization_id, workspace_id, post)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->put_organization_workspaces_assignments: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
organization_id | int | Numeric ID of the organization | |
workspace_id | int | Numeric ID of the workspace within the organization | |
post | UserAssignmentsPayload | Describes the change in assignment |
str
- Content-Type: Not defined
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str put_workspace_users(workspace_id, user_id)
Update workspace user
Update the data for a user in a given workspace.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
workspace_id = 56 # int | Numeric ID of the workspace
user_id = 56 # int | Numeric ID of the user
try:
# Update workspace user
api_response = api_instance.put_workspace_users(workspace_id, user_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->put_workspace_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace | |
user_id | int | Numeric ID of the user |
str
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
str put_workspace_workspace_users(workspace_id, workspace_user_id, post)
Update workspace-user
Update the data for a workspace_user in a given workspace.
from __future__ import print_function
import time
import toggl
from toggl.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: BasicAuth
configuration = toggl.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# create an instance of the API class
api_instance = toggl.UsersApi(toggl.ApiClient(configuration))
workspace_id = 56 # int | Numeric ID of the workspace
workspace_user_id = 56 # int | Numeric ID of the workspace user
post = toggl.UserPayload() # UserPayload | Changes that need to be applied to the user data.
try:
# Update workspace-user
api_response = api_instance.put_workspace_workspace_users(workspace_id, workspace_user_id, post)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->put_workspace_workspace_users: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
workspace_id | int | Numeric ID of the workspace | |
workspace_user_id | int | Numeric ID of the workspace user | |
post | UserPayload | Changes that need to be applied to the user data. |
str
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]