...
- See api_users for definitions of other attributes and elements
Attribute | Value | Required? |
---|---|---|
id | API User ID | Required for edit, omit for add |
co_id | CO ID | Yes |
username | API Username | Yes |
api_key | API Key | Not permitted on write operations, use generate instead |
status | API User Status | Yes |
privileged | Whether this API User is privileged | |
valid_from | Valid from (timestamp) | |
valid_through | Valid through (timestamp) | |
remote_ip | Regular 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/"
} |
...