API users implementation guide

Overview page

On page load, call SearchUsers:

{
  "IncludeCustomers": "false",
  "IncludeEmployees": "false",
  "Types": 2048
}

Filters

Query

{
    "IncludeCustomers": "false",
    "IncludeEmployees": "false",
    "Types": 2048,
    "SearchQuery": "rylo"
}

UserID

{
    "IncludeCustomers": "false",
    "IncludeEmployees": "false",
    "Types": 2048,
    "UserIDs": [5]
}

Name

{
    "IncludeCustomers": "false",
    "IncludeEmployees": "false",
    "Types": 2048,
    "Name": "rylo"
}

Role

{
    "IncludeCustomers": "false",
    "IncludeEmployees": "false",
    "Types": 2048,
    "RoleID": 1
}

Detail page

On page load, call ListUserApiKeys with the appropriate UserID:

{
    "UserID": 4
}

The response will include an array of keys for this user under Result.Page.[0].

We could optionally include the actual key in the response somehow, but that is a security matter for either Coen or AJ. The interface I've drawn out above is impossible without having the actual keys. Maybe introduce an additional service to fetch a specific key when so desired.

When creating a new API key:

{
    "UserID": 45,
    "OrganizationUnitID": 23,
    "RequestPermanentApiKey": true,
    "Description": "Whatever"
}

Optionally make a description required from the FE.

Problems

User description

There's no description field on API users.