Jump to

• Request
• Response

View User Groups for Project

get

/api/restapi/project/userGroups

Send a request to this endpoint to view the user groups accessible for the provided project.

Request

Query Parameters

• inheritedUsers: boolean
  Enabling this boolean flag will include all inherited users assigned to the user groups.
  Allowed Values: [ "true", "false" ]

  Default Value: false
• 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 : ApiEntityUserGroups

Type: object

Title: ApiEntityUserGroups

Show Source

• userGroups: array userGroups
  User Groups Data.

{
    "title":"ApiEntityUserGroups",
    "type":"object",
    "properties":{
        "userGroups":{
            "type":"array",
            "description":"User Groups Data.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityUserGroup",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : userGroups

Type: array

User Groups Data.

Show Source

• Array of: object ApiEntityUserGroup
  Title: ApiEntityUserGroup

{
    "type":"array",
    "description":"User Groups Data.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserGroup",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserGroup

Type: object

Title: ApiEntityUserGroup

Show Source

• assignedUsers: array assignedUsers
  List of assigned users in the user group.
• displayName: string
  Maximum Length: 255

  Name of a user group.
• inherited: boolean
  Indicates if the user group is inherited.
• ownedWorkspaceId: integer (int64)
  The unique identifier of a workspace.
• ownedWorkspaceName: string
  The name of the owning workspace of the user group.
• scope: string
  Allowed Values: [ "PROJECT", "WORKSPACE" ]

  Indicates whether the user group is present in the workspace/project.
• scopeId: integer (int64)
  The unique identifier of a project/workspace.
• userGroupEnabled: boolean
  Indicates the state of the user group.
• userGroupId: integer (int64)
  The unique identifier of a user group.

{
    "title":"ApiEntityUserGroup",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The unique identifier of a project/workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "displayName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of a user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownedWorkspaceName":{
            "type":"string",
            "description":"The name of the owning workspace of the user group.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userGroupEnabled":{
            "type":"boolean",
            "description":"Indicates the state of the user group.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "ownedWorkspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignedUsers":{
            "type":"array",
            "description":"List of assigned users in the user group.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignedUsers",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "inherited":{
            "type":"boolean",
            "description":"Indicates if the user group is inherited.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "userGroupId":{
            "type":"integer",
            "description":"The unique identifier of a user group.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "type":"string",
            "description":"Indicates whether the user group is present in the workspace/project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROJECT",
                "WORKSPACE"
            ]
        }
    },
    "exampleSetFlag":false
}

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 : 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 user groups in the given project.

Back to Top