View Permission Sets and Users Assigned to User Group for Project
get
/api/restapi/project/userGroups/permissionSets
Send a request to this endpoint to view permission sets and users assigned to a user group at the provided project.
Request
Query Parameters
-
projectCode(required): string
Project code of the project to be found.
This is a required field. -
projectId(required): integer(int64)
ID of the project to be found.
This is a required field. -
workspaceCode(required): string
Workspace code of the project to be found.
This is a required field. -
workspaceId: integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityUserGroupsPermissionAssignmentsProject>
Type:
array
Title:
Show Source
List<ApiEntityUserGroupsPermissionAssignmentsProject>
-
Array of:
object ApiEntityUserGroupsPermissionAssignmentsProject
Title:
ApiEntityUserGroupsPermissionAssignmentsProject
Nested Schema : ApiEntityUserGroupsPermissionAssignmentsProject
Type:
object
Title:
Show Source
ApiEntityUserGroupsPermissionAssignmentsProject
-
assignedPermissions:
assignedPermissions
List of assigned user permission profiles in the user group.
-
assignedUsers: array
assignedUsers
List of assigned users in the user group.
-
userGroupId: string
The unique identifier of the user group.
-
userGroupName: string
The name displayed of the user group.
Nested Schema : assignedPermissions
List of assigned user permission profiles in the user group.
Match All
List of assigned user permission profiles in the user group.
Show Source
-
object
ApiEntityAssignedPermissionsProject
Title:
ApiEntityAssignedPermissionsProject
Nested Schema : assignedUsers
Type:
array
List of assigned users in the user group.
Show Source
-
Array of:
object ApiEntityAssignedUsers
Title:
ApiEntityAssignedUsers
Nested Schema : ApiEntityAssignedPermissionsProject
Type:
object
Title:
Show Source
ApiEntityAssignedPermissionsProject
-
customLog:
customLog
Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs. -
file:
file
File permission sets.
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs. -
project:
project
Project permission sets.
Applicable for workspace, project retrieve APIs. -
report:
report
Report permission sets.
Applicable for workspace, project, program, portfolio, report retrieve APIs.
Nested Schema : customLog
Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.
Match All
Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.
Show Source
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.
-
object
ApiEntityBaseProfile
Title:
ApiEntityBaseProfile
Nested Schema : file
File permission sets.
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.
Match All
File permission sets.
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.
Show Source
Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.
-
object
ApiEntityBaseProfile
Title:
ApiEntityBaseProfile
Nested Schema : project
Project permission sets.
Applicable for workspace, project retrieve APIs.
Applicable for workspace, project retrieve APIs.
Match All
Project permission sets.
Applicable for workspace, project retrieve APIs.
Show Source
Applicable for workspace, project retrieve APIs.
-
object
ApiEntityBaseProfile
Title:
ApiEntityBaseProfile
Nested Schema : report
Report permission sets.
Applicable for workspace, project, program, portfolio, report retrieve APIs.
Applicable for workspace, project, program, portfolio, report retrieve APIs.
Match All
Report permission sets.
Applicable for workspace, project, program, portfolio, report retrieve APIs.
Show Source
Applicable for workspace, project, program, portfolio, report retrieve APIs.
-
object
ApiEntityBaseProfile
Title:
ApiEntityBaseProfile
Nested Schema : ApiEntityBaseProfile
Type:
object
Title:
Show Source
ApiEntityBaseProfile
-
profileId: string
Maximum Length:
255
Profile ID. -
profileName: string
Maximum Length:
255
Profile Name.
Nested Schema : ApiEntityAssignedUsers
Type:
object
Title:
Show Source
ApiEntityAssignedUsers
-
displayName: string
The name displayed of the user when logged into the system.
-
userName: string
The identification used by a user to log in to the system.
204 Response
Successful operation with no content.
404 Response
Error loading permission sets and users assigned to a user group in the given project.