Versions Compared

Key

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

...

ResourceApiUsers
URL/api/v2/api_users
Supported Standard Operations
  • Add
  • Delete
  • Edit
  • View (one)
  • View (all)
Additional Operations
  • Generate

Attributes

See api_users

...

for definitions of

...

attributes.

...

Valid from (timestamp)

...

Sample Record

Code Block
{
  "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/"
}

...

POST /registry/api/v2/api_key/16
{
}
 
200 OK
{
  "results": {
    "api_key": "hjem-9725-udxp-2388"
  }
}

Implementation Notes

Edit

api_key is read-only, and may not be updated using Edit. Use Generate instead.