Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityUserGroupsPermissionAssignmentsProject>

Type: array

Title: List<ApiEntityUserGroupsPermissionAssignmentsProject>

Show Source

• Array of: object ApiEntityUserGroupsPermissionAssignmentsProject
  Title: ApiEntityUserGroupsPermissionAssignmentsProject

{
    "title":"List<ApiEntityUserGroupsPermissionAssignmentsProject>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserGroupsPermissionAssignmentsProject",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserGroupsPermissionAssignmentsProject

Type: object

Title: ApiEntityUserGroupsPermissionAssignmentsProject

Show Source

• 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.

{
    "title":"ApiEntityUserGroupsPermissionAssignmentsProject",
    "type":"object",
    "properties":{
        "userGroupName":{
            "type":"string",
            "description":"The name displayed of the user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignedUsers":{
            "type":"array",
            "description":"List of assigned users in the user group.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignedUsers",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "userGroupId":{
            "type":"string",
            "description":"The unique identifier of the user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignedPermissions":{
            "description":"List of assigned user permission profiles in the user group.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityAssignedPermissionsProject"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

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

{
    "description":"List of assigned user permission profiles in the user group.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityAssignedPermissionsProject"
        }
    ]
}

Nested Schema : assignedUsers

Type: array

List of assigned users in the user group.

Show Source

• Array of: object ApiEntityAssignedUsers
  Title: ApiEntityAssignedUsers

{
    "type":"array",
    "description":"List of assigned users in the user group.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignedUsers",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityAssignedPermissionsProject

Type: object

Title: ApiEntityAssignedPermissionsProject

Show Source

• 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.

{
    "title":"ApiEntityAssignedPermissionsProject",
    "type":"object",
    "properties":{
        "file":{
            "description":"File permission sets. <br>Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        },
        "report":{
            "description":"Report permission sets. <br>Applicable for workspace, project, program, portfolio, report retrieve APIs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        },
        "customLog":{
            "description":"Custom log  permission sets. <br>Applicable for workspace, project, program, customLogTypeObject retrieve APIs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        },
        "project":{
            "description":"Project permission sets. <br>Applicable for workspace, project retrieve APIs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : customLog

Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.

Match All

Custom log permission sets.
Applicable for workspace, project, program, customLogTypeObject retrieve APIs.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"Custom log  permission sets. <br>Applicable for workspace, project, program, customLogTypeObject retrieve APIs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBaseProfile"
        }
    ]
}

Nested Schema : file

File permission sets.
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

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"File permission sets. <br>Applicable for workspace, project, program, portfolio, idea, document retrieve APIs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBaseProfile"
        }
    ]
}

Nested Schema : project

Project permission sets.
Applicable for workspace, project retrieve APIs.

Match All

Project permission sets.
Applicable for workspace, project retrieve APIs.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"Project permission sets. <br>Applicable for workspace, project retrieve APIs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBaseProfile"
        }
    ]
}

Nested Schema : report

Report permission sets.
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

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"Report permission sets. <br>Applicable for workspace, project, program, portfolio, report retrieve APIs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityBaseProfile"
        }
    ]
}

Nested Schema : ApiEntityBaseProfile

Type: object

Title: ApiEntityBaseProfile

Show Source

• profileId: string
  Maximum Length: 255

  Profile ID.
• profileName: string
  Maximum Length: 255

  Profile Name.

{
    "title":"ApiEntityBaseProfile",
    "type":"object",
    "properties":{
        "profileId":{
            "maxLength":255,
            "type":"string",
            "description":"Profile ID.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "profileName":{
            "maxLength":255,
            "type":"string",
            "description":"Profile Name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignedUsers

Type: object

Title: ApiEntityAssignedUsers

Show Source

• 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.

{
    "title":"ApiEntityAssignedUsers",
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "description":"The name displayed of the user when logged into the system. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "type":"string",
            "description":"The identification used by a user to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

Error loading permission sets and users assigned to a user group in the given project.

Back to Top