LIliongard
Groups

List Groups

Returns a List of available Assignable Roles for a user

get/groups

Request

  • Base URL
    https://example.app.liongard.com/api/v1
  • URL
    https://example.app.liongard.com/api/v1/groups
  • Auth
    API key in header X-ROAR-API-KEY

Query parameters

fields[]string[]

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

conditions[]unknown

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

Response

IDinteger
Environmentunknown
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"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.