Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • See api_users for definitions of other attributes and elements
AttributeValueRequired?
idAPI User IDRequired for edit, omit for add
co_idCO IDYes
usernameAPI UsernameYes
api_keyAPI KeyNot permitted on write operations, use generate instead
statusAPI User StatusYes
privilegedWhether this API User is privileged
valid_from

Valid from (timestamp)


valid_throughValid through (timestamp)
remote_ipRegular expression describing permitted remote IP addresses for this API User

Sample Record

Code Block
{
  "id": 16,
  "co_id": 2,
  "username": "TestCO.apiuser",
  "api_key": "$2y$10$p/8mPy9hm1OU3tlvV4gHpG.e7ONH1YqBbcXGppxHyDz9awpbYQAfP",
  "status": "A",
  "privileged": true,
  "valid_from": null,
  "valid_through": "2019-06-30T03:59:59+00:00",
  "remote_ip": "/10\.0\.1\.2/"
}

...