Assign Permission Profiles To User
post
/api/restapi/workspace/assignUser
Use this endpoint to assign workspace permission profiles to multiple user.
Request
Header Parameters
-
singleTransaction:
Enabling this boolean flag fails to complete the request if an error occurred when validating any user permission profile sent as part of the request.
Allowed Values: [ "true", "false" ]Default Value:false
Supported Media Types
- application/json
Root Schema : ApiEntityWorkspaceUserPermissions
Type:
object
Title:
Show Source
ApiEntityWorkspaceUserPermissions
-
profiles: array
profiles
List of user profiles.
-
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.
Nested Schema : profiles
Type:
array
List of user profiles.
Show Source
-
Array of:
object ApiEntityWorkspaceProfileInput
Title:
ApiEntityWorkspaceProfileInput
Nested Schema : ApiEntityWorkspaceProfileInput
Type:
object
Title:
Show Source
ApiEntityWorkspaceProfileInput
-
customLogProfileId: string
Maximum Length:
255
System-defined identifier of the custom log profile. -
fileProfileId: string
Maximum Length:
255
System-defined identifier of the document profile. -
ideaProfileId: string
Maximum Length:
255
System-defined identifier of the idea profile. -
portfolioProfileId: string
Maximum Length:
255
System-defined identifier of the portfolio profile. -
programProfileId: string
Maximum Length:
255
System-defined identifier of the program profile. -
projectProfileId: string
Maximum Length:
255
System-defined identifier of the project profile. -
reportProfileId: string
Maximum Length:
255
System-defined identifier of the report profile. -
userName: string
Maximum Length:
255
Username of the user for permission assignment. -
workspaceProfileId: string
Maximum Length:
255
System-defined identifier of the workspace profile.
Examples
Back to Top
Response
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : ApiEntityWorkspaceUserPermissionsResponse
Type:
object
Title:
Show Source
ApiEntityWorkspaceUserPermissionsResponse
-
profiles: array
profiles
Profiles response with individual message and statusCodes.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : profiles
Type:
array
Profiles response with individual message and statusCodes.
Show Source
-
Array of:
object ApiEntityProfileResponse
Title:
ApiEntityProfileResponse
Nested Schema : ApiEntityProfileResponse
Type:
object
Title:
Show Source
ApiEntityProfileResponse
-
message: string
Error message or reason for operation failure is populated. The field is non-persistable and thus maximum length is not applicable.
-
profileId: string
Maximum Length:
255
The system-defined unique identifier of an object profile. -
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.