| Resource | ApiUsers |
|---|---|
| URL | /api/v2/api_users |
| Supported Standard Operations |
|
| Additional Operations |
|
Attributes
- See api_users for definitions of other attributes and elements
| Attribute | Value | Required? |
|---|---|---|
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
{
"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/"
}
Supported Filters
View (all)
Additional filters:
co_id
Example: Obtain API Users in a given CO
GET /registry/api/v2/api_users?co_id=2
Additional Operations
Generate
Generate an API key for an existing object. This call must be made after a successful add request, using the resulting API User ID.
Request Format
| Request | POST /api/v2/api_users/generate/id |
|---|---|
Request Body | Empty JSON document (see example, this is not the same as an empty document) |
| Paginated? | No |
Response Format
HTTP Status | Response Body | Description |
|---|---|---|
| Update successful | |
| Error Response | Attribute validation failed or id not found |
| Authentication required | |
| Error Response | Server error |
Example: Generate API Key
|