Class Users

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

In Crowdin Enterprise users are the members of your organization with the defined access levels. Use API to get the list of organization users and to check the information on a specific user.

Hierarchy (view full)

CrowdinApi
- Users

Index

Constructors

constructor

Methods

addProjectMember deleteMemberFromProject deleteUser editAuthenticatedUser editUser editUserProjectPermissions getAuthenticatedUser getProjectMemberPermissions getUserInfo graphql inviteUser listProjectMembers listUserProjectContributions listUserProjectPermissions listUsers replaceProjectMemberPermissions withFetchAll

Constructors

constructor

new Users(credentials, config?): Users
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Users
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:232

Methods

addProjectMember

addProjectMember(projectId, request): Promise<AddProjectMemberResponse>
Parameters
- projectId: number
  project identifier
- request: AddProjectMemberRequest
  request body
Returns Promise<AddProjectMemberResponse>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.members.post
- Defined in users/index.ts:80

deleteMemberFromProject

deleteMemberFromProject(projectId, memberId): Promise<void>
Parameters
- projectId: number
  project identifier
- memberId: number
  member identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.members.delete
- Defined in users/index.ts:120

deleteUser

deleteUser(userId): Promise<void>
Parameters
- userId: number
  user identifier
Returns Promise<void>
See
https://support.crowdin.com/enterprise/api/#operation/api.users.delete
- Defined in users/index.ts:200

getProjectMemberPermissions

getProjectMemberPermissions(projectId, memberId): Promise<ResponseObject<ProjectMember | EnterpriseProjectMember>>
Parameters
- projectId: number
  project identifier
- memberId: number
  member identifier
Returns Promise<ResponseObject<ProjectMember | EnterpriseProjectMember>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.members.get
- Defined in users/index.ts:93

getUserInfo

getUserInfo(userId): Promise<ResponseObject<UsersModel.User>>
Parameters
- userId: number
  user identifier
Returns Promise<ResponseObject<UsersModel.User>>
See
https://support.crowdin.com/enterprise/api/#operation/api.users.getById
- Defined in users/index.ts:191

graphql

graphql<T>(req, config?): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
- config: {
  url?: string;
  } = {}
  - Optionalurl?: string
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:266

inviteUser

inviteUser(request): Promise<ResponseObject<UsersModel.User>>
Parameters
- request: InviteUserRequest
  request body
Returns Promise<ResponseObject<UsersModel.User>>
See
https://support.crowdin.com/enterprise/api/#operation/api.users.post
- Defined in users/index.ts:182

listProjectMembers

listProjectMembers(projectId, options?): Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListProjectMembersOptions
  optional parameters for the request
Returns Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.members.getMany
- Defined in users/index.ts:27
listProjectMembers(projectId, search?, role?, languageId?, limit?, offset?): Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>
Parameters
- projectId: number
  project identifier
- Optionalsearch: string
  search users by firstName, lastName or username
- Optionalrole: Role
  defines role type
- OptionallanguageId: string
  language identifier
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.members.getMany
- Defined in users/index.ts:41

listUserProjectContributions

listUserProjectContributions(userId, options?): Promise<ResponseList<UsersModel.ProjectPermissions>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<UsersModel.ProjectPermissions>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.users.projects.contributions.getMany
- Defined in users/index.ts:263

listUserProjectPermissions

listUserProjectPermissions(userId, options?): Promise<ResponseList<UsersModel.ProjectPermissions>>
Parameters
- userId: number
  user identifier
- Optionaloptions: Partial<Pagination>
  request options
Returns Promise<ResponseList<UsersModel.ProjectPermissions>>
See
https://developer.crowdin.com/enterprise/api/v2/#operation/api.users.projects.permissions.getMany
- Defined in users/index.ts:237

listUsers

listUsers(options?): Promise<ResponseList<UsersModel.User>>
Parameters
- Optionaloptions: ListUsersOptions
  optional parameters for the request
Returns Promise<ResponseList<UsersModel.User>>
See
https://support.crowdin.com/enterprise/api/#operation/api.users.getMany
- Defined in users/index.ts:129
listUsers(status?, search?, twoFactor?, limit?, offset?): Promise<ResponseList<UsersModel.User>>
Parameters
- Optionalstatus: UsersModel.Status
  filter users by status
- Optionalsearch: string
  search users by firstName, lastName, username, email
- OptionaltwoFactor: TwoFactor
  filter users by two-factor authentication status
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<UsersModel.User>>
Deprecated
optional parameters should be passed through an object

See
https://support.crowdin.com/enterprise/api/#operation/api.users.getMany
- Defined in users/index.ts:139

replaceProjectMemberPermissions

replaceProjectMemberPermissions(projectId, memberId, request?): Promise<ResponseObject<ProjectMember | EnterpriseProjectMember>>
Parameters
- projectId: number
  project identifier
- memberId: number
  member identifier
- request: ReplaceProjectMemberRequest = {}
Returns Promise<ResponseObject<ProjectMember | EnterpriseProjectMember>>
See
https://support.crowdin.com/enterprise/api/#operation/api.projects.members.put
- Defined in users/index.ts:106

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:328

Class Users

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Users

Methods

addProjectMember

Parameters

Returns Promise<AddProjectMemberResponse>

See

deleteMemberFromProject

Parameters

Returns Promise<void>

See

deleteUser

Parameters

Returns Promise<void>

See

editAuthenticatedUser

Parameters

Returns Promise<ResponseObject<UsersModel.User>>

See

editUser

Parameters

Returns Promise<ResponseObject<UsersModel.User>>

See

editUserProjectPermissions

Parameters

Returns Promise<ResponseList<UsersModel.ProjectPermissions>>

See

getAuthenticatedUser

Returns Promise<ResponseObject<UsersModel.User>>

See

getProjectMemberPermissions

Parameters

Returns Promise<ResponseObject<ProjectMember | EnterpriseProjectMember>>

See

getUserInfo

Parameters

Returns Promise<ResponseObject<UsersModel.User>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Optionalurl?: string

Returns Promise<ResponseObject<T>>

inviteUser

Parameters

Returns Promise<ResponseObject<UsersModel.User>>

See

listProjectMembers

Parameters

Returns Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>

See

Parameters

Returns Promise<ResponseList<ProjectMember | EnterpriseProjectMember>>

Deprecated

See

listUserProjectContributions

Parameters

Returns Promise<ResponseList<UsersModel.ProjectPermissions>>

See

listUserProjectPermissions

Parameters

Returns Promise<ResponseList<UsersModel.ProjectPermissions>>

See

listUsers

Parameters

Returns Promise<ResponseList<UsersModel.User>>

See

Parameters

Returns Promise<ResponseList<UsersModel.User>>

Deprecated

`Optional`operationName?: string

`Optional`variables?: any

`Optional`url?: string