Remove Users Assigned to a Project
post
/api/restapi/project/removeUsers
Send a request to this endpoint to remove users from a project.
Request
Header Parameters
-
singleTransaction: boolean
Enabling this boolean flag fails to complete the request if an error occurred while processing any user removal sent as part of the request.
Allowed Values: [ "true", "false" ]Default Value:false
Supported Media Types
- application/json
Root Schema : ApiEntityRemoveProjectUserPermissions
Type:
object
Title:
Show Source
ApiEntityRemoveProjectUserPermissions
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
userNames: array
userNames
List of user names for removing users.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Response
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntityRemoveProjectUserPermissionsResponse>
Type:
array
Title:
Show Source
List<ApiEntityRemoveProjectUserPermissionsResponse>
-
Array of:
object ApiEntityRemoveProjectUserPermissionsResponse
Title:
ApiEntityRemoveProjectUserPermissionsResponse
Nested Schema : ApiEntityRemoveProjectUserPermissionsResponse
Type:
object
Title:
Show Source
ApiEntityRemoveProjectUserPermissionsResponse
-
message: string
Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
-
projectId: integer
(int64)
The unique identifier for the project.
-
statusCode: integer
(int32)
The response code representing the state of the API operation.
-
userName: string
Maximum Length:
255
Username of the user for permission assignment.
400 Response
Invalid input for the Project service.