Module `crowdin_api.api_resources.users.resource`

Classes

class BaseUsersResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Ancestors

BaseResource

Subclasses

EnterpriseUsersResource
UsersResource

Methods

def get_authenticated_user(self)
def get_members_path(self, projectId: int, memberId: Optional[int] = None)

class EnterpriseUsersResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Enterprise platform Users.

Users API gives you the possibility to get profile information about the currently authenticated user.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#tag/Users

Ancestors

Methods

def add_project_member(self, userIds: Iterable[int], projectId: Optional[int] = None, accessToAllWorkflowSteps: Optional[bool] = None, managerAccess: Optional[bool] = None, permissions: Optional[Dict[~KT, ~VT]] = None, roles: Optional[Iterable[ProjectMemberRole]] = None): Add Project Member.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.members.post
def delete_member_from_project(self, memberId: int, projectId: Optional[int] = None): Delete Member From Project.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.members.delete
def delete_user(self, userId: int): Delete User.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.users.delete
def edit_user(self, userId: int, data: Iterable[UserPatchRequest]): Edit User.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.users.patch
def get_users_path(self, userId: Optional[int] = None)
def invite_user(self, email: str, firstName: Optional[str] = None, lastName: Optional[str] = None, timezone: Optional[str] = None): Invite User.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.users.post
def list_project_members(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, search: Optional[str] = None, workflowStepId: Optional[int] = None, languageId: Optional[str] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None): List Project Members.

Link to documentation for enterprise: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.members.getMany
def replace_project_member_permissions(self, memberId: int, projectId: Optional[int] = None, accessToAllWorkflowSteps: Optional[bool] = None, managerAccess: Optional[bool] = None, permissions: Optional[Dict[~KT, ~VT]] = None, roles: Optional[Iterable[ProjectMemberRole]] = None): Replace Project Member Permissions.

Link to documentation: https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.members.put

class UsersResource (requester: APIRequester, project_id: Optional[int] = None, page_size=25)

Resource for Users.

Users API gives you the possibility to get profile information about the currently authenticated user.

Link to documentation: https://developer.crowdin.com/api/v2/#tag/Users

Ancestors

Methods

def get_member_info(self, memberId: int, projectId: Optional[int] = None): Get Member Info.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.projects.members.get
def list_project_members(self, projectId: Optional[int] = None, orderBy: Optional[Sorting] = None, search: Optional[str] = None, role: Optional[UserRole] = None, languageId: Optional[str] = None, page: Optional[int] = None, offset: Optional[int] = None, limit: Optional[int] = None): List Project Members.

Link to documentation: https://developer.crowdin.com/api/v2/#operation/api.projects.members.getMany