Remove Users Assigned to a Portfolio
post
/api/restapi/portfolio/removeUsers
Send a request to this endpoint to remove users from a portfolio.
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 : ApiEntityRemovePortfolioUserPermissions
Type:
object
Title:
Show Source
ApiEntityRemovePortfolioUserPermissions
-
portfolioId: integer
(int64)
The system-generated identifier of a portfolio.
-
portfolioName: string
Maximum Length:
255
The name of the portfolio. -
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<ApiEntityRemovePortfolioUserPermissionsResponse>
Type:
array
Title:
Show Source
List<ApiEntityRemovePortfolioUserPermissionsResponse>
-
Array of:
object ApiEntityRemovePortfolioUserPermissionsResponse
Title:
ApiEntityRemovePortfolioUserPermissionsResponse
Nested Schema : ApiEntityRemovePortfolioUserPermissionsResponse
Type:
object
Title:
Show Source
ApiEntityRemovePortfolioUserPermissionsResponse
-
message: string
Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
-
portfolioId: integer
(int64)
The system-generated identifier of a portfolio.
-
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 portfolio service.