phrasetms_client.UserApi

All URIs are relative to https://cloud.memsource.com/web

Method	HTTP request	Description
cancel_deletion	POST /api2/v1/users/{userUid}/undelete	Restore user
create_user_v3	POST /api2/v3/users	Create user
delete_user1	DELETE /api2/v1/users/{userUid}	Delete user
disable_two_factor_auth_v3	POST /api2/v3/users/{userUid}/disableTwoFactorAuth	Disable two-factor authentication
get_list_of_users_filtered	GET /api2/v1/users	List users
get_user_v3	GET /api2/v3/users/{userUid}	Get user
list_assigned_projects	GET /api2/v1/users/{userUid}/projects	List assigned projects
list_jobs	GET /api2/v1/users/{userUid}/jobs	List assigned jobs
list_target_langs	GET /api2/v1/users/{userUid}/targetLangs	List assigned target languages
list_workflow_steps	GET /api2/v1/users/{userUid}/workflowSteps	List assigned workflow steps
login_activity	GET /api2/v1/users/{userUid}/loginStatistics	Login statistics
send_login_info	POST /api2/v1/users/{userUid}/emailLoginInformation	Send login information
update_password	POST /api2/v1/users/{userUid}/updatePassword	Update password
update_user_v3	PUT /api2/v3/users/{userUid}	Edit user
user_last_logins	GET /api2/v1/users/lastLogins	List last login dates

cancel_deletion

UserDto cancel_deletion(user_uid)

Restore user

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_dto import UserDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Restore user
        api_response = api_instance.cancel_deletion(user_uid)
        print("The response of UserApi->cancel_deletion:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->cancel_deletion: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

UserDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_user_v3

UserDetailsDtoV3 create_user_v3(body=body)

Create user

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_user_create_dto import AbstractUserCreateDto
from phrasetms_client.models.user_details_dto_v3 import UserDetailsDtoV3
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    body = phrasetms_client.AbstractUserCreateDto() # AbstractUserCreateDto |  (optional)

    try:
        # Create user
        api_response = api_instance.create_user_v3(body=body)
        print("The response of UserApi->create_user_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->create_user_v3: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	AbstractUserCreateDto		[optional]

Return type

UserDetailsDtoV3

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_user1

delete_user1(user_uid)

Delete user

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Delete user
        api_instance.delete_user1(user_uid)
    except Exception as e:
        print("Exception when calling UserApi->delete_user1: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_two_factor_auth_v3

UserDetailsDtoV3 disable_two_factor_auth_v3(user_uid)

Disable two-factor authentication

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_details_dto_v3 import UserDetailsDtoV3
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Disable two-factor authentication
        api_response = api_instance.disable_two_factor_auth_v3(user_uid)
        print("The response of UserApi->disable_two_factor_auth_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->disable_two_factor_auth_v3: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

UserDetailsDtoV3

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_list_of_users_filtered

PageDtoUserDto get_list_of_users_filtered(first_name=first_name, last_name=last_name, name=name, user_name=user_name, email=email, name_or_email=name_or_email, role=role, include_deleted=include_deleted, page_number=page_number, page_size=page_size, sort=sort, order=order)

List users

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_user_dto import PageDtoUserDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    first_name = 'first_name_example' # str | Filter for first name, that starts with value (optional)
    last_name = 'last_name_example' # str | Filter for last name, that starts with value (optional)
    name = 'name_example' # str | Filter for last name or first name, that starts with value (optional)
    user_name = 'user_name_example' # str |  (optional)
    email = 'email_example' # str |  (optional)
    name_or_email = 'name_or_email_example' # str | Filter for last name, first name or email starting with the value (optional)
    role = ['role_example'] # List[str] |  (optional)
    include_deleted = False # bool |  (optional) (default to False)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 50 # int | Page size, accepts values between 1 and 50, default 50 (optional) (default to 50)
    sort = ['sort_example'] # List[str] |  (optional)
    order = ['order_example'] # List[str] |  (optional)

    try:
        # List users
        api_response = api_instance.get_list_of_users_filtered(first_name=first_name, last_name=last_name, name=name, user_name=user_name, email=email, name_or_email=name_or_email, role=role, include_deleted=include_deleted, page_number=page_number, page_size=page_size, sort=sort, order=order)
        print("The response of UserApi->get_list_of_users_filtered:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->get_list_of_users_filtered: %s\n" % e)

Parameters

Name	Type	Description	Notes
first_name	str	Filter for first name, that starts with value	[optional]
last_name	str	Filter for last name, that starts with value	[optional]
name	str	Filter for last name or first name, that starts with value	[optional]
user_name	str		[optional]
email	str		[optional]
name_or_email	str	Filter for last name, first name or email starting with the value	[optional]
role	List[str]		[optional]
include_deleted	bool		[optional] [default to False]
page_number	int	Page number, starting with 0, default 0	[optional] [default to 0]
page_size	int	Page size, accepts values between 1 and 50, default 50	[optional] [default to 50]
sort	List[str]		[optional]
order	List[str]		[optional]

Return type

PageDtoUserDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_v3

UserDetailsDtoV3 get_user_v3(user_uid)

Get user

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_details_dto_v3 import UserDetailsDtoV3
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Get user
        api_response = api_instance.get_user_v3(user_uid)
        print("The response of UserApi->get_user_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->get_user_v3: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

UserDetailsDtoV3

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_assigned_projects

PageDtoProjectReference list_assigned_projects(user_uid, status=status, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, project_name=project_name, page_number=page_number, page_size=page_size)

List assigned projects

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_project_reference import PageDtoProjectReference
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    status = ['status_example'] # List[str] |  (optional)
    target_lang = ['target_lang_example'] # List[str] |  (optional)
    workflow_step_id = 56 # int |  (optional)
    due_in_hours = 56 # int | -1 for jobs that are overdue (optional)
    filename = 'filename_example' # str |  (optional)
    project_name = 'project_name_example' # str |  (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)

    try:
        # List assigned projects
        api_response = api_instance.list_assigned_projects(user_uid, status=status, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, project_name=project_name, page_number=page_number, page_size=page_size)
        print("The response of UserApi->list_assigned_projects:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->list_assigned_projects: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
status	List[str]		[optional]
target_lang	List[str]		[optional]
workflow_step_id	int		[optional]
due_in_hours	int	-1 for jobs that are overdue	[optional]
filename	str		[optional]
project_name	str		[optional]
page_number	int		[optional] [default to 0]
page_size	int		[optional] [default to 50]

Return type

PageDtoProjectReference

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_jobs

PageDtoAssignedJobDto list_jobs(user_uid, status=status, project_uid=project_uid, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)

List assigned jobs

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_assigned_job_dto import PageDtoAssignedJobDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    status = ['status_example'] # List[str] |  (optional)
    project_uid = 'project_uid_example' # str |  (optional)
    target_lang = ['target_lang_example'] # List[str] |  (optional)
    workflow_step_id = 56 # int |  (optional)
    due_in_hours = 56 # int | -1 for jobs that are overdue (optional)
    filename = 'filename_example' # str |  (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)

    try:
        # List assigned jobs
        api_response = api_instance.list_jobs(user_uid, status=status, project_uid=project_uid, target_lang=target_lang, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)
        print("The response of UserApi->list_jobs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->list_jobs: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
status	List[str]		[optional]
project_uid	str		[optional]
target_lang	List[str]		[optional]
workflow_step_id	int		[optional]
due_in_hours	int	-1 for jobs that are overdue	[optional]
filename	str		[optional]
page_number	int		[optional] [default to 0]
page_size	int		[optional] [default to 50]

Return type

PageDtoAssignedJobDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_target_langs

PageDtoString list_target_langs(user_uid, status=status, project_uid=project_uid, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)

List assigned target languages

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_string import PageDtoString
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    status = ['status_example'] # List[str] |  (optional)
    project_uid = 'project_uid_example' # str |  (optional)
    workflow_step_id = 56 # int |  (optional)
    due_in_hours = 56 # int | -1 for jobs that are overdue (optional)
    filename = 'filename_example' # str |  (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)

    try:
        # List assigned target languages
        api_response = api_instance.list_target_langs(user_uid, status=status, project_uid=project_uid, workflow_step_id=workflow_step_id, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)
        print("The response of UserApi->list_target_langs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->list_target_langs: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
status	List[str]		[optional]
project_uid	str		[optional]
workflow_step_id	int		[optional]
due_in_hours	int	-1 for jobs that are overdue	[optional]
filename	str		[optional]
page_number	int		[optional] [default to 0]
page_size	int		[optional] [default to 50]

Return type

PageDtoString

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_workflow_steps

PageDtoWorkflowStepReference list_workflow_steps(user_uid, status=status, project_uid=project_uid, target_lang=target_lang, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)

List assigned workflow steps

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_workflow_step_reference import PageDtoWorkflowStepReference
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    status = ['status_example'] # List[str] |  (optional)
    project_uid = 'project_uid_example' # str |  (optional)
    target_lang = ['target_lang_example'] # List[str] |  (optional)
    due_in_hours = 56 # int | -1 for jobs that are overdue (optional)
    filename = 'filename_example' # str |  (optional)
    page_number = 0 # int |  (optional) (default to 0)
    page_size = 50 # int |  (optional) (default to 50)

    try:
        # List assigned workflow steps
        api_response = api_instance.list_workflow_steps(user_uid, status=status, project_uid=project_uid, target_lang=target_lang, due_in_hours=due_in_hours, filename=filename, page_number=page_number, page_size=page_size)
        print("The response of UserApi->list_workflow_steps:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->list_workflow_steps: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
status	List[str]		[optional]
project_uid	str		[optional]
target_lang	List[str]		[optional]
due_in_hours	int	-1 for jobs that are overdue	[optional]
filename	str		[optional]
page_number	int		[optional] [default to 0]
page_size	int		[optional] [default to 50]

Return type

PageDtoWorkflowStepReference

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

login_activity

UserStatisticsListDto login_activity(user_uid)

Login statistics

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_statistics_list_dto import UserStatisticsListDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Login statistics
        api_response = api_instance.login_activity(user_uid)
        print("The response of UserApi->login_activity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->login_activity: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

UserStatisticsListDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_login_info

send_login_info(user_uid)

Send login information

Example

import time
import os
import phrasetms_client
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 

    try:
        # Send login information
        api_instance.send_login_info(user_uid)
    except Exception as e:
        print("Exception when calling UserApi->send_login_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_password

update_password(user_uid, body=body)

Update password

Password length must be between 8 and 255 * Password must not be same as the username

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.user_password_edit_dto import UserPasswordEditDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    body = phrasetms_client.UserPasswordEditDto() # UserPasswordEditDto |  (optional)

    try:
        # Update password
        api_instance.update_password(user_uid, body=body)
    except Exception as e:
        print("Exception when calling UserApi->update_password: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
body	UserPasswordEditDto		[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user_v3

UserDetailsDtoV3 update_user_v3(user_uid, body=body)

Edit user

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.abstract_user_edit_dto import AbstractUserEditDto
from phrasetms_client.models.user_details_dto_v3 import UserDetailsDtoV3
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_uid = 'user_uid_example' # str | 
    body = phrasetms_client.AbstractUserEditDto() # AbstractUserEditDto |  (optional)

    try:
        # Edit user
        api_response = api_instance.update_user_v3(user_uid, body=body)
        print("The response of UserApi->update_user_v3:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->update_user_v3: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_uid	str
body	AbstractUserEditDto		[optional]

Return type

UserDetailsDtoV3

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_last_logins

PageDtoLastLoginDto user_last_logins(user_name=user_name, role=role, sort=sort, order=order, page_number=page_number, page_size=page_size)

List last login dates

Example

import time
import os
import phrasetms_client
from phrasetms_client.models.page_dto_last_login_dto import PageDtoLastLoginDto
from phrasetms_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://cloud.memsource.com/web
# See configuration.py for a list of all supported configuration parameters.
configuration = phrasetms_client.Configuration(
    host = "https://cloud.memsource.com/web"
)


# Enter a context with an instance of the API client
with phrasetms_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = phrasetms_client.UserApi(api_client)
    user_name = 'user_name_example' # str |  (optional)
    role = ['role_example'] # List[str] |  (optional)
    sort = ['sort_example'] # List[str] |  (optional)
    order = ['order_example'] # List[str] |  (optional)
    page_number = 0 # int | Page number, starting with 0, default 0 (optional) (default to 0)
    page_size = 100 # int | Page size, accepts values between 1 and 100, default 100 (optional) (default to 100)

    try:
        # List last login dates
        api_response = api_instance.user_last_logins(user_name=user_name, role=role, sort=sort, order=order, page_number=page_number, page_size=page_size)
        print("The response of UserApi->user_last_logins:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling UserApi->user_last_logins: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_name	str		[optional]
role	List[str]		[optional]
sort	List[str]		[optional]
order	List[str]		[optional]
page_number	int	Page number, starting with 0, default 0	[optional] [default to 0]
page_size	int	Page size, accepts values between 1 and 100, default 100	[optional] [default to 100]

Return type

PageDtoLastLoginDto

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	successful operation	-
400	Bad request	-
401	Not authorized	-
403	Forbidden	-
404	Resource not found	-
405	Method not allowed	-
408	Timeout	-
410	Gone	-
415	Unsupported media type	-
429	Too many requests	-
500	Internal server error	-
501	Not implemented	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

phrasetms_client.UserApi

cancel_deletion

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_user_v3

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

disable_two_factor_auth_v3

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_list_of_users_filtered

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_v3

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_assigned_projects

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_jobs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_target_langs

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_workflow_steps

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

login_activity

Example

Parameters