| Resource | ApiUsers |
|---|---|
| URL | /api/v2/api_users |
| Supported Standard Operations |
|
Attributes
- 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
{
"id": 5,
"co_id": 2,
"parent_id": null,
"name": "Researchers",
"description": "Test CO Researcher"
}
Implementation Notes
View (all)
Additional filters:
co_id
Example: Obtain API Users in a given CO
GET /registry/api/v2/api_users.json?co_id=2