Project User Management Tasks

The basic tasks for creating and managing Project Users are described below. A Platform Admin can perform all these actions, and many can also be performed by Project Admins. For more details, refer to individual APIs.

Project User Management


POST ${baseUrl}/v1/projects/{project_key}/roles 
GET /v1/projects/{project_key}/roles/{role} 
PUT /v1/projects/{project_key}/roles/{role} 
DELETE /v1/projects/{project_key}/roles/{role}
PUT ${baseUrl}/access/api/v1/projects/{project_key} 
PUT ${baseUrl}/access/api/v1/projects/{project_key} 
GET ${baseUrl}/access/api/v1/projects/{project_key}/users/{user}
GET ${baseUrl}/access/api/v1/projects/{project_key}/users
PUT ${baseUrl}/access/api/v1/projects/{project_key}/users/{user}
DELETE ${baseUrl}/access/api/v1/projects/{project_key}/users/{user} 
GET ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
GET ${baseUrl}/access/api/v1/projects/{project_key}/groups
PUT ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
DELETE ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
GET ${baseUrl}/access/api/v1/projects/{project_key}/users
PUT ${baseUrl}/access/api/v1/projects/{project_key} 

#	Procedure	Using Platform UI	Using APIs
1	Create a project role	Step 1: Create Project Roles	Create RoleCreate Role POST ${baseUrl}/v1/projects/{project_key}/roles
2	Get a project role	Manage Project Roles	Get Project RoleGet Project Role GET /v1/projects/{project_key}/roles/{role}
3	Update a project role	Update a Global or Project Role	Update an Existing Project RoleUpdate an Existing Project Role PUT /v1/projects/{project_key}/roles/{role}
4	Delete a project role	Manage Project Roles	Delete an Existing RoleDelete an Existing Role DELETE /v1/projects/{project_key}/roles/{role}
5	Add a user to a project	Step 2: Assign Members to a Project	Add User in ProjectAdd or Update User in Project PUT ${baseUrl}/access/api/v1/projects/{project_key}
6	Update a user in a project	Step 2: Add Members to Projects	Add or Update User in ProjectAdd or Update User in Project PUT ${baseUrl}/access/api/v1/projects/{project_key}
7	Get a project user	Manage Project Roles	Get Project UserGet Project User GET ${baseUrl}/access/api/v1/projects/{project_key}/users/{user}
8	Get all the project users	Manage Project Roles	Get Project UsersGet Project Users GET ${baseUrl}/access/api/v1/projects/{project_key}/users
9	Update a project user	Manage Project Roles	Add or Update User in ProjectAdd or Update User in Project PUT ${baseUrl}/access/api/v1/projects/{project_key}/users/{user}
10	Delete project user	Remove a Project Member	Delete Existing Project's UserDelete Existing Project's User DELETE ${baseUrl}/access/api/v1/projects/{project_key}/users/{user}
11	Get a project group	Manage Project Roles	Get Projects GroupGet Projects Group GET ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
12	Get all the project groups	Manage Project Roles	Get Projects GroupsGet Projects Groups GET ${baseUrl}/access/api/v1/projects/{project_key}/groups
13	Update a project group	Manage Project Roles	Update Group in ProjectUpdate Group in Project PUT ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
14	Delete a project group	Remove a Project Group	Delete Existing Project's GroupDelete Existing Project's Group DELETE ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
15	View project admins, groups and users	Modify a Project	Get Project UsersGet Project Users GET ${baseUrl}/access/api/v1/projects/{project_key}/users Get Projects GroupGet Projects Group GET ${baseUrl}/access/api/v1/projects/{project_key}/groups/{group}
16	Edit project admin privileges	Modify a Project	Update Existing Project PropertiesUpdate Existing Project Properties PUT ${baseUrl}/access/api/v1/projects/{project_key}