GET api/securitygroups

Get list of security groups

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OnePlanSecurityGroup
NameDescriptionTypeAdditional information
GroupName

string

None.

License

globally unique identifier

None.

PermissionSettings

Permissions

None.

IsDefault

boolean

None.

id

globally unique identifier

None.

ConfigId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "GroupName": "sample string 1",
    "License": "14ba9665-4e79-48d5-91f8-d588bcc3e99f",
    "PermissionSettings": {
      "GlobalPermissionSettings": {
        "Administrator": true,
        "EditAllPlans": true,
        "ManageData": true,
        "ViewAllPlans": true,
        "ViewAllResources": true,
        "ManageResources": true
      },
      "PlanPermissions": {
        "AddPlan": true,
        "ArchivePlan": true,
        "DeletePlan": true
      },
      "HiddenLeftNavigation": [
        "sample string 1",
        "sample string 2"
      ],
      "HiddenPlanNavigation": [
        "sample string 1",
        "sample string 2"
      ],
      "HiddenAreas": [
        "2af7068a-4844-4dbd-b8da-f25b0dd84e21",
        "6ec96b94-741e-452a-b4b6-0cb2925065ba"
      ]
    },
    "IsDefault": true,
    "id": "107ae6fb-7ca0-4fb9-b5fd-8a0ea1feef56",
    "ConfigId": "03535828-cff6-4de2-b8ee-0762c3acec4c"
  },
  {
    "GroupName": "sample string 1",
    "License": "14ba9665-4e79-48d5-91f8-d588bcc3e99f",
    "PermissionSettings": {
      "GlobalPermissionSettings": {
        "Administrator": true,
        "EditAllPlans": true,
        "ManageData": true,
        "ViewAllPlans": true,
        "ViewAllResources": true,
        "ManageResources": true
      },
      "PlanPermissions": {
        "AddPlan": true,
        "ArchivePlan": true,
        "DeletePlan": true
      },
      "HiddenLeftNavigation": [
        "sample string 1",
        "sample string 2"
      ],
      "HiddenPlanNavigation": [
        "sample string 1",
        "sample string 2"
      ],
      "HiddenAreas": [
        "2af7068a-4844-4dbd-b8da-f25b0dd84e21",
        "6ec96b94-741e-452a-b4b6-0cb2925065ba"
      ]
    },
    "IsDefault": true,
    "id": "107ae6fb-7ca0-4fb9-b5fd-8a0ea1feef56",
    "ConfigId": "03535828-cff6-4de2-b8ee-0762c3acec4c"
  }
]