Users

API Documentation for the BugSplat Users Endpoint

This endpoint supports paging and filtering queries. More information paging, filtering, and grouping is available here.

Get a list of users, add a user, or remove a user from a specified database.

Get Users

GET https://app.bugsplat.com/api/user/users

Returns a list of users and access rights for the specified database.

Query Parameters

Name	Type	Description
database	string	BugSplat database containing users

200

[
  {
    "dbId": 4321,
    "dbName": "Fred",
    "uId": 55411,
    "username": "[e-mail]",
    "firstName": "Fred",
    "lastName": "Flintstone",
    "lastLogin": "2021-08-25T21:02:56Z",
    "unrestricted": 1,
    "ssoGroups": ""
  }
]

Curl Example

curl --location 'https://app.bugsplat.com/api/user/users?database=fred' \
--header 'Authorization: Bearer ••••••'

Add Users

POST https://app.bugsplat.com/api/user/users

Adds a new user to the specified database. PUT is also accepted at this same endpoint and behaves identically, including updating the rights of an existing user.

Request Body

Name	Type	Description
database	string	BugSplat database to add the user to
username	string	Email of user to be added to the database
rights	number	Optional. 1 for unrestricted access, 0 for restricted access (default 0)

200

{
    "status": "success",
    "companyId": 1234,
    "database": 4321,
    "uId": 55411
}

Curl Example

curl --location 'https://app.bugsplat.com/api/user/users' \
--header 'xsrf-token: ajKqRF12QJJ3IlLFdCEH0RhMjpuD5scz86mul3zdjTYA' \
--header 'Cookie: user=fred%40bugsplat.com; PHPSESSID=4g3pr9rdtehoddac9ohrt1qrc3cehg54; xsrf-token=ajKqRF12QJJ3IlLFdCEH0RhMjpuD5scz86mul3zdjTYA' \
--form 'database="fred"' \
--form 'username="[e-mail]"'

Delete Users

DELETE https://app.bugsplat.com/api/user/users

Removes a user from the specified database. The authenticated user must not be restricted for this call to succeed.

Query Parameters

Name	Type	Description
database	string	BugSplat database that contains the user
username	string	Email of the user to remove

200

{
    "status": "success",
    "uId": 55411,
}

Curl Example

curl --location --request DELETE 'https://app.bugsplat.com/api/user/users?database=fred&username=name%40test.com' \
--header 'xsrf-token: ajKqRF12QJJ3IlLFdCEH0RhMjpuD5scz86mul3zdjTYA' \
--header 'Cookie: user=fred%40bugsplat.com; PHPSESSID=4g3pr9rdtehoddac9ohrt1qrc3cehg54; xsrf-token=ajKqRF12QJJ3IlLFdCEH0RhMjpuD5scz86mul3zdjTYA'