org.qubership.atp.users.clients.api

Interface ProjectsApi

All Known Subinterfaces:

UsersProjectFeignClient

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2025-08-08T10:00:10.259Z[Etc/UTC]")
 @Validated
public interface ProjectsApi

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ProjectDto>	deleteUserFromProject(UUID projectId, String userId) DELETE /api/v1/users/projects/{projectId}/users/{userId} : Delete user from project
org.springframework.http.ResponseEntity<List<EntityDto>>	getAllEntities(UUID projectId) GET /api/v1/users/projects/{projectId}/entities : Return all entities
org.springframework.http.ResponseEntity<List<GroupDto>>	getAllGroups(UUID projectId) GET /api/v1/users/projects/{projectId}/users/groups : Get all groups
org.springframework.http.ResponseEntity<List<ProjectDto>>	getAllProjects() GET /api/v1/users/projects : Get all projects in collection
org.springframework.http.ResponseEntity<Map<String,OperationsDto>>	getCustomPermissions(UUID projectId, String groupAlias) GET /api/v1/users/projects/{projectId}/group/{groupAlias}/permissions : Get custom permissions in specified project for specified group
org.springframework.http.ResponseEntity<Void>	getPermissionsForCurrentUser(UUID projectId) GET /api/v1/users/projects/{projectId}/user/permissions : Return permissions for current user on project
org.springframework.http.ResponseEntity<ProjectDto>	getProjectById(UUID projectId) GET /api/v1/users/projects/{projectId} : Get project by id
org.springframework.http.ResponseEntity<List<UserInfoDto>>	getProjectsUsersEnrichedByUuid(UUID projectId) Deprecated.
org.springframework.http.ResponseEntity<List<UserInfoDto>>	getProjectsUsersEnrichedByUuidAndGroupAlias(UUID projectId, String groupAlias) GET /api/v1/users/projects/{projectId}/groups/{groupAlias}/users/enriched : Get unique users of the project by project ID and group alias
org.springframework.http.ResponseEntity<ProjectDto>	getProjectUsersByProjectId(UUID projectId) Deprecated.
org.springframework.http.ResponseEntity<ProjectDto>	getProjectUsersByProjectIdAndGroupAlias(UUID projectId, String groupAlias) GET /api/v1/users/projects/{projectId}/group/{groupAlias}/users : Get users on the project by id
org.springframework.http.ResponseEntity<Void>	updatePermissionsByProjectIdAndGroupAlias(UUID projectId, String groupAlias, @Valid Map<String,OperationsDto> requestBody) PATCH /api/v1/users/projects/{projectId}/group/{groupAlias}/permissions : Update permissions in specified project for specified group
org.springframework.http.ResponseEntity<ProjectDto>	updateProjectUsers(@NotNull @Valid String type, @Valid ProjectDto projectDto) Deprecated.
org.springframework.http.ResponseEntity<ProjectDto>	updateProjectUsersInGroup(UUID projectId, String groupAlias, @Valid ProjectDto projectDto) PUT /api/v1/users/projects/{projectId}/groups/{groupAlias}/users : Update projects user

Method Detail

deleteUserFromProject

@RequestMapping(method=DELETE,
                value="/api/v1/users/projects/{projectId}/users/{userId}",
                produces="application/json")
org.springframework.http.ResponseEntity<ProjectDto> deleteUserFromProject(@PathVariable(value="projectId")
                                                                                                                                                                                                                                 UUID projectId,
                                                                                                                                                                                                                                 @PathVariable(value="userId")
                                                                                                                                                                                                                                 String userId)

DELETE /api/v1/users/projects/{projectId}/users/{userId} : Delete user from project

Parameters:

projectId - Project ID (required)

userId - User ID (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getAllEntities

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/entities",
                produces="application/json")
org.springframework.http.ResponseEntity<List<EntityDto>> getAllEntities(@PathVariable(value="projectId")
                                                                                                                                                                                                                      UUID projectId)

GET /api/v1/users/projects/{projectId}/entities : Return all entities

Parameters:

projectId - Project ID for check access (required)

Returns:

List of service entity (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getAllGroups

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/users/groups",
                produces="application/json")
org.springframework.http.ResponseEntity<List<GroupDto>> getAllGroups(@PathVariable(value="projectId")
                                                                                                                                                                                                                       UUID projectId)

GET /api/v1/users/projects/{projectId}/users/groups : Get all groups

Parameters:

projectId - Project ID to check access (required)

Returns:

Default user groups and permissions (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getAllProjects

@RequestMapping(method=GET,
                value="/api/v1/users/projects",
                produces="application/json")
org.springframework.http.ResponseEntity<List<ProjectDto>> getAllProjects()

GET /api/v1/users/projects : Get all projects in collection

Returns:

OK (status code 200) or (status code 401) or (status code 403) or (status code 500)

getCustomPermissions

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/group/{groupAlias}/permissions",
                produces="application/json")
org.springframework.http.ResponseEntity<Map<String,OperationsDto>> getCustomPermissions(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                            UUID projectId,
                                                                                                                                                                                                                                                            @PathVariable(value="groupAlias")
                                                                                                                                                                                                                                                            String groupAlias)

GET /api/v1/users/projects/{projectId}/group/{groupAlias}/permissions : Get custom permissions in specified project for specified group

Parameters:

projectId - Project ID (required)

groupAlias - Group alias (required)

Returns:

Permissions for specified group in project (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getPermissionsForCurrentUser

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/user/permissions")
org.springframework.http.ResponseEntity<Void> getPermissionsForCurrentUser(@PathVariable(value="projectId")
                                                                                                                                                                                    UUID projectId)

GET /api/v1/users/projects/{projectId}/user/permissions : Return permissions for current user on project

Parameters:

projectId - Project ID (required)

Returns:

(status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getProjectById

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}",
                produces="application/json")
org.springframework.http.ResponseEntity<ProjectDto> getProjectById(@PathVariable(value="projectId")
                                                                                                                                                                                                        UUID projectId)

GET /api/v1/users/projects/{projectId} : Get project by id

Parameters:

projectId - Project ID (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getProjectUsersByProjectId

@Deprecated
 @RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/users",
                produces="application/json")
org.springframework.http.ResponseEntity<ProjectDto> getProjectUsersByProjectId(@PathVariable(value="projectId")
                                                                                                                                                                                                                                       UUID projectId)

Deprecated.

GET /api/v1/users/projects/{projectId}/users : Get users on the project by id

Parameters:

projectId - Project ID (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getProjectUsersByProjectIdAndGroupAlias

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/group/{groupAlias}/users",
                produces="application/json")
org.springframework.http.ResponseEntity<ProjectDto> getProjectUsersByProjectIdAndGroupAlias(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                          UUID projectId,
                                                                                                                                                                                                                                                          @PathVariable(value="groupAlias")
                                                                                                                                                                                                                                                          String groupAlias)

GET /api/v1/users/projects/{projectId}/group/{groupAlias}/users : Get users on the project by id

Parameters:

projectId - Project ID (required)

groupAlias - Group Alias (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getProjectsUsersEnrichedByUuid

@Deprecated
 @RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/users/enriched",
                produces="application/json")
org.springframework.http.ResponseEntity<List<UserInfoDto>> getProjectsUsersEnrichedByUuid(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                           UUID projectId)

Deprecated.

GET /api/v1/users/projects/{projectId}/users/enriched : Get unique users of the project by project ID

Parameters:

projectId - Project ID (required)

Returns:

Information about unique users of the project (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

getProjectsUsersEnrichedByUuidAndGroupAlias

@RequestMapping(method=GET,
                value="/api/v1/users/projects/{projectId}/groups/{groupAlias}/users/enriched",
                produces="application/json")
org.springframework.http.ResponseEntity<List<UserInfoDto>> getProjectsUsersEnrichedByUuidAndGroupAlias(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                                               UUID projectId,
                                                                                                                                                                                                                                                                               @PathVariable(value="groupAlias")
                                                                                                                                                                                                                                                                               String groupAlias)

GET /api/v1/users/projects/{projectId}/groups/{groupAlias}/users/enriched : Get unique users of the project by project ID and group alias

Parameters:

projectId - Project ID (required)

groupAlias - Group alias (required)

Returns:

Information about unique users of the project (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

updatePermissionsByProjectIdAndGroupAlias

@RequestMapping(method=PATCH,
                value="/api/v1/users/projects/{projectId}/group/{groupAlias}/permissions",
                consumes="application/json")
org.springframework.http.ResponseEntity<Void> updatePermissionsByProjectIdAndGroupAlias(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                              UUID projectId,
                                                                                                                                                                                                                                                              @PathVariable(value="groupAlias")
                                                                                                                                                                                                                                                              String groupAlias,
                                                                                                                                                                                                                                                              @Valid @RequestBody
                                                                                                                                                                                                                                                              @Valid Map<String,OperationsDto> requestBody)

PATCH /api/v1/users/projects/{projectId}/group/{groupAlias}/permissions : Update permissions in specified project for specified group

Parameters:

projectId - Project ID (required)

groupAlias - Group alias (required)

requestBody - Entities with custom permissions (required)

Returns:

(status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

updateProjectUsers

@Deprecated
 @RequestMapping(method=PUT,
                value="/api/v1/users/projects/update/users",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ProjectDto> updateProjectUsers(@NotNull @Valid @RequestParam(value="type",required=true)
                                                                                                                                                                                                                                                                       @NotNull @Valid String type,
                                                                                                                                                                                                                                                                       @Valid @RequestBody
                                                                                                                                                                                                                                                                       @Valid ProjectDto projectDto)

Deprecated.

PUT /api/v1/users/projects/update/users : Update projects user

Parameters:

type - type of user (required)

projectDto - project entity (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)

updateProjectUsersInGroup

@RequestMapping(method=PUT,
                value="/api/v1/users/projects/{projectId}/groups/{groupAlias}/users",
                produces="application/json",
                consumes="application/json")
org.springframework.http.ResponseEntity<ProjectDto> updateProjectUsersInGroup(@PathVariable(value="projectId")
                                                                                                                                                                                                                                                                                          UUID projectId,
                                                                                                                                                                                                                                                                                          @PathVariable(value="groupAlias")
                                                                                                                                                                                                                                                                                          String groupAlias,
                                                                                                                                                                                                                                                                                          @Valid @RequestBody
                                                                                                                                                                                                                                                                                          @Valid ProjectDto projectDto)

PUT /api/v1/users/projects/{projectId}/groups/{groupAlias}/users : Update projects user

Parameters:

projectId - Project Id to check access (required)

groupAlias - Users group (required)

projectDto - Project entity (required)

Returns:

OK (status code 200) or (status code 400) or (status code 401) or (status code 403) or (status code 500)