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 other attributes and elements

...

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/"
}

...

Supported Filters

View (all)

Additional filters:

  • co_id

Example: Obtain API Users in a given CO

Code Block
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.

...

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

View (all)

Additional filters:

  • co_id

Example: Obtain API Users in a given CO

...