Sign in

v1

latestOpenAPI 3.0.02026-07-249372139.7 KB
Users

List Users

Returns a list of users in your Liongard Instance

get/users

Query parameters

fields[]string[]

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

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

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

Response

EnvironmentNamestring nullable
IDinteger
{"stackTrail":"components:schemas:Users:properties:Environment","oasType":"schema","type":"unknown","example":null,"nullable":true}
FirstNamestring
LastNamestring
Emailstring
Usernamestring
MfaFactorAuthboolean
Status'active' | 'invited'
Ownerboolean
Visibleboolean
Lockedboolean
LastLoginstring date-time
ReceiveTechUpdatesboolean
Department'Sales' | 'Onboarding' | 'Service Desk/NOC' | 'Account Management/vCIO' | 'Finance' | 'Leadership' | 'Other'
CreatedOnstring date-time
UpdatedOnstring date-time

Example response

[
  {
    "ID": 3,
    "FirstName": "Alex",
    "LastName": "Weber",
    "Email": "Alex.Weber@contoso.com",
    "Username": "Alex.Weber",
    "MfaFactorAuth": true,
    "Status": "active",
    "Visible": true,
    "LastLogin": "2021-07-22T14:47:36.286Z",
    "Department": "Other",
    "CreatedOn": "2021-07-22T14:47:36.286Z",
    "UpdatedOn": "2021-07-22T14:47:36.286Z",
    "Preferences": {
      "ColorTheme": {
        "name": "Light Mode",
        "cssClass": "light-mode"
      }
    },
    "Groups": [
      {
        "ID": 85783,
        "Name": "Manager",
        "EnvironmentName": "Contoso Nation"
      }
    ],
    "CreatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    },
    "UpdatedBy": {
      "ID": 1234,
      "FirstName": "Alex",
      "LastName": "Weber",
      "Username": "Alex.Weber"
    }
  }
]