UserApi
extends AbstractApi
in package
Users are the members of your organization with the defined access levels (e.g. manager, admin, contributor).
Use API to get the list of organization users and to check the information on a specific user.
Table of Contents
Methods
- addProjectTeamMember() : ProjectTeamMemberAddedStatistics|null
- Add Project Member
- delete() : mixed
- Delete User
- deleteMemberFromProject() : void
- Delete Member From Project
- get() : User|null
- Get User Info
- getAuthenticatedUser() : User|null
- Get Authenticated User
- getProjectMemberPermissions() : ProjectTeamMemberResource|null
- Get Project Member Permissions
- invite() : User|null
- Invite User
- list() : ModelCollection
- List Users
- listProjectContributions() : ModelCollection
- List User Projects Contributions
- listProjectMembers() : ModelCollection
- List Project Members
- listProjectPermissions() : ModelCollection
- List User Projects Permissions
- replaceProjectMemberPermissions() : ProjectTeamMemberResource|null
- Replace Project Member Permissions
- update() : User|null
- Update User
- updateProjectPermissions() : ModelCollection
- Permissions Batch Operations
Methods
addProjectTeamMember()
Add Project Member
public
addProjectTeamMember(int $projectId, array<string|int, mixed> $data) : ProjectTeamMemberAddedStatistics|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
Tags
Return values
ProjectTeamMemberAddedStatistics|nulldelete()
Delete User
public
delete(int $userId) : mixed
Parameters
- $userId : int
Tags
deleteMemberFromProject()
Delete Member From Project
public
deleteMemberFromProject(int $projectId, int $memberId) : void
Parameters
- $projectId : int
- $memberId : int
Tags
get()
Get User Info
public
get(int $userId) : User|null
Parameters
- $userId : int
Tags
Return values
User|nullgetAuthenticatedUser()
Get Authenticated User
public
getAuthenticatedUser() : User|null
Tags
Return values
User|nullgetProjectMemberPermissions()
Get Project Member Permissions
public
getProjectMemberPermissions(int $projectId, int $memberId) : ProjectTeamMemberResource|null
Parameters
- $projectId : int
- $memberId : int
Tags
Return values
ProjectTeamMemberResource|nullinvite()
Invite User
public
invite(array<string|int, mixed> $data) : User|null
Parameters
- $data : array<string|int, mixed>
Tags
Return values
User|nulllist()
List Users
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
Tags
Return values
ModelCollectionlistProjectContributions()
List User Projects Contributions
public
listProjectContributions(int $userId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $userId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistProjectMembers()
List Project Members
public
listProjectMembers(int $projectId[, array<string|int, mixed> $data = [] ]) : ModelCollection
Parameters
- $projectId : int
- $data : array<string|int, mixed> = []
Tags
Return values
ModelCollectionlistProjectPermissions()
List User Projects Permissions
public
listProjectPermissions(int $userId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $userId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionreplaceProjectMemberPermissions()
Replace Project Member Permissions
public
replaceProjectMemberPermissions(int $projectId, int $memberId, array<string|int, mixed> $data) : ProjectTeamMemberResource|null
Parameters
- $projectId : int
- $memberId : int
- $data : array<string|int, mixed>
Tags
Return values
ProjectTeamMemberResource|nullupdate()
Update User
public
update(User $user) : User|null
Parameters
- $user : User
Tags
Return values
User|nullupdateProjectPermissions()
Permissions Batch Operations
public
updateProjectPermissions(int $userId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $userId : int
- $data : array<string|int, mixed>
-
JSON Patch array. op: add, replace or remove, path: /{projectId}/roles
value: list of role name and permissions