Module crowdin_api.api_resources.users.resource

Classes

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

Base class with methods shared by UsersResource and EnterpriseUsersResource.

Ancestors

Subclasses

Methods

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

Delete Member From Project.

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

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

def get_authenticated_user(self)

Get Authenticated User.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.user.get

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.user.get

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

Get Member Info.

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

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

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://support.crowdin.com/developer/enterprise/api/v2/#tag/Users

Ancestors

Methods

def add_project_member(self, userIds: Optional[Iterable[int]] = None, projectId: Optional[int] = None, accessToAllWorkflowSteps: Optional[bool] = None, managerAccess: Optional[bool] = None, permissions: Optional[Dict[~KT, ~VT]] = None, roles: Optional[Iterable[ProjectMemberRole]] = None, usernames: Optional[Iterable[str]] = None, emails: Optional[Iterable[str]] = None, developerAccess: Optional[bool] = None)

Add Project Member.

One of userIds, usernames or emails is required.

accessToAllWorkflowSteps and permissions are deprecated by the API, use roles instead.

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

def delete_user(self, userId: int)

Delete User.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.delete

def edit_user(self, userId: int, data: Iterable[UserPatchRequest])

Edit User.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.patch

def edit_user_project_permissions(self, userId: int, data: Iterable[UserProjectPermissionsPatchRequest])

Edit User Project Permissions.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.projects.permissions.patch

def get_group_manager(self, group_id: int, user_id: int)

Get Group Manager

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Users/operation/api.groups.managers.get

def get_group_managers_path(self, group_id: int, user_id: Optional[int] = None)
def get_user(self, userId: int)

Get User.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.getById

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, adminAccess: Optional[bool] = None)

Invite User.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.post

def list_group_managers(self, group_id: int, team_ids: Optional[Iterable[int]] = None, order_by: Optional[Sorting] = None, offset: Optional[int] = None, limit: Optional[int] = None)

List Group Managers

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Users/operation/api.groups.managers.getMany

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://support.crowdin.com/developer/enterprise/api/v2/#operation/api.projects.members.getMany

def list_user_project_contributions(self, userId: int, offset: Optional[int] = None, limit: Optional[int] = None)

List User Project Contributions.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.projects.contributions.getMany

def list_user_project_permissions(self, userId: int, offset: Optional[int] = None, limit: Optional[int] = None)

List User Project Permissions.

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#operation/api.users.projects.permissions.getMany

def list_users(self, limit: Optional[int] = None, offset: Optional[int] = None, order_by: Optional[Sorting] = None, status: Optional[UserStatus] = None, search: Optional[str] = None, two_factor: Optional[str] = None, organization_roles: Optional[Iterable[OrganizationRole]] = None, team_id: Optional[int] = None, project_ids: Optional[Iterable[int]] = None, project_roles: Optional[Iterable[str]] = None, language_ids: Optional[Iterable[str]] = None, group_ids: Optional[Iterable[int]] = None, last_seen_from: Optional[datetime.datetime] = None, last_seen_to: Optional[datetime.datetime] = None)

List Users

Link to documentation: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Users/operation/api.users.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, developerAccess: Optional[bool] = None)

Replace Project Member Permissions.

accessToAllWorkflowSteps and permissions are deprecated by the API, use roles instead.

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

def update_group_managers(self, group_id: int, request_data: Iterable[GroupManagerPatchRequest])

Update Group Managers

Link to documentation for enterprise: https://support.crowdin.com/developer/enterprise/api/v2/#tag/Users/operation/api.groups.managers.patch

Inherited members

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://support.crowdin.com/developer/api/v2/#tag/Users

Ancestors

Methods

def add_project_member(self, userIds: Optional[Iterable[int]] = None, projectId: Optional[int] = None, usernames: Optional[Iterable[str]] = None, emails: Optional[Iterable[str]] = None, managerAccess: Optional[bool] = None, developerAccess: Optional[bool] = None, roles: Optional[Iterable[ProjectMemberRole]] = None, message: Optional[str] = None)

Add Project Member.

One of userIds, usernames or emails is required. managerAccess, developerAccess and roles are mutually exclusive.

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

def edit_authenticated_user(self, data: Iterable[AuthenticatedUserPatchRequest])

Edit Authenticated User.

Link to documentation: https://support.crowdin.com/developer/api/v2/#operation/api.user.patch

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://support.crowdin.com/developer/api/v2/#operation/api.projects.members.getMany

def replace_project_member_permissions(self, memberId: int, projectId: Optional[int] = None, managerAccess: Optional[bool] = None, developerAccess: Optional[bool] = None, roles: Optional[Iterable[ProjectMemberRole]] = None)

Replace Project Member Permissions.

managerAccess, developerAccess and roles are mutually exclusive.

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

Inherited members