v1

latestOpenAPI 3.0.02026-07-249372139.7 KB

Groups

List Groups

Returns a List of available Assignable Roles for a user

get/groups

Query parameters

fields[]string[]

Will only return the fields specified from this parameter, multiple uses of the parameter required for multiple fields

{"stackTrail":"paths:/groups:get:parameters:1:schema","oasType":"schema","type":"unknown"}

conditions[]={"path":"Field Path","op":"Operator","value":"value"}

Response

IDinteger

{"stackTrail":"components:schemas:Groups:properties:Environment","oasType":"schema","type":"unknown","example":null,"nullable":true}

Namestring

Descriptionstring

Visibleboolean

Lockedboolean nullable

CreatedOnstring date-time

UpdatedOnstring date-time nullable

Example response

{
  "ID": 12942,
  "Name": "Reader",
  "Description": "Users who will view Environments, Inspectors, Agents, and all features within an Environment.",
  "Visible": true,
  "CreatedOn": "2024-07-23T22:46:33.202",
  "Roles": [
    {
      "ID": 600,
      "Name": "Agent Reader",
      "Description": "Agent Read-Only Permissions"
    }
  ]
}