Jump to

• Request
• Response

View Permission Sets assigned to all users at Workspace

get

/api/restapi/workspace/users/permissionSets

Send a request to this endpoint to view the permission sets assigned to all the users at the provided workspace.

Request

Query Parameters

• workspaceCode: string
  The user-specified identifier of a workspace.
• 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<ApiEntityUserPermissionAssignments>

Type: array

Title: List<ApiEntityUserPermissionAssignments>

Show Source

• Array of: object ApiEntityUserPermissionAssignments
  Title: ApiEntityUserPermissionAssignments

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

Nested Schema : ApiEntityUserPermissionAssignments

Type: object

Title: ApiEntityUserPermissionAssignments

Show Source

• assignedPermissions: assignedPermissions
  List of assigned user permission profiles.
• 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":"ApiEntityUserPermissionAssignments",
    "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"
            ]
        },
        "assignedPermissions":{
            "description":"List of assigned user permission profiles.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityAssignedPermissions"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : assignedPermissions

List of assigned user permission profiles.

Match All

List of assigned user permission profiles.

Show Source

• object ApiEntityAssignedPermissions
  Title: ApiEntityAssignedPermissions

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

Nested Schema : ApiEntityAssignedPermissions

Type: object

Title: ApiEntityAssignedPermissions

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.
• idea: idea
  Idea permission sets.
  Applicable for workspace, idea retrieve APIs.
• portfolio: portfolio
  Portfolio permission sets.
  Applicable for workspace, portfolio retrieve APIs.
• program: program
  Program permission sets.
  Applicable for workspace, program 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.
• workspace: workspace
  Workspace permission sets.
  Applicable for workspace retrieve API.

{
    "title":"ApiEntityAssignedPermissions",
    "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"
                }
            ]
        },
        "workspace":{
            "description":"Workspace permission sets. <br>Applicable for workspace retrieve API.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        },
        "portfolio":{
            "description":"Portfolio permission sets. <br>Applicable for workspace, portfolio 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"
                }
            ]
        },
        "program":{
            "description":"Program permission sets. <br>Applicable for workspace, program retrieve APIs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityBaseProfile"
                }
            ]
        },
        "idea":{
            "description":"Idea permission sets. <br>Applicable for workspace, idea 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 : idea

Idea permission sets.
Applicable for workspace, idea retrieve APIs.

Match All

Idea permission sets.
Applicable for workspace, idea retrieve APIs.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

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

Nested Schema : portfolio

Portfolio permission sets.
Applicable for workspace, portfolio retrieve APIs.

Match All

Portfolio permission sets.
Applicable for workspace, portfolio retrieve APIs.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

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

Nested Schema : program

Program permission sets.
Applicable for workspace, program retrieve APIs.

Match All

Program permission sets.
Applicable for workspace, program retrieve APIs.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"Program permission sets. <br>Applicable for workspace, program 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 : workspace

Workspace permission sets.
Applicable for workspace retrieve API.

Match All

Workspace permission sets.
Applicable for workspace retrieve API.

Show Source

• object ApiEntityBaseProfile
  Title: ApiEntityBaseProfile

{
    "description":"Workspace permission sets. <br>Applicable for workspace retrieve API.",
    "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
}

204 Response

Successful operation with no content.

404 Response

Error loading permission sets assigned to all users in the given workspace.

Back to Top