Users
Users
Manage the data held about people in your team using the following requests.
Return the details of all of the users in your team
GET /users
GET /users
Example request
curl \-H "Authorization: Bearer YOUR-API-KEY" \"https://api.vidbeo.com/v2/users"Example response
{ "success": true, "result": [ { "id": "abcde12345abcde12345a", "name": "Test User", "role": "viewer", "authentication": "password", "notifications": [], "enabled": true, "mfa_required": false, "verified_email": true, "created_by": "abcde12345abcde1234a", "created_time": "2022-01-01T00:00:00.000Z", "updated_by": "abcde12345abcde12345a", "updated_time": "2022-01-01T00:00:00.000Z" }, ... ], "links": {}, "errors": []}Optional parameters
| Name | Type | Default | Information |
|---|---|---|---|
| limit | String | 25 | Maximum number to return |
| cursor | String | "" | Used to get the next page of results: if applicable we return this as part of the links.next URL |
Return the details of a user
GET /users/:id
GET /users/:id
Example request
curl \-H "Authorization: Bearer YOUR-API-KEY" \"https://api.vidbeo.com/v2/users/abcde12345abcde12345a"Example response
{ "success": true, "result": { "id": "abcde12345abcde12345a", "name": "Test User", "role": "viewer", "authentication": "password", "notifications": [], "enabled": true, "mfa_required": false, "verified_email": true, "created_by": "abcde12345abcde1234a", "created_time": "2022-01-01T00:00:00.000Z", "updated_by": "abcde12345abcde12345a", "updated_time": "2022-01-01T00:00:00.000Z" }, "links": null, "errors": []}Response format
| Key | Type | Description |
|---|---|---|
| id | String | The unique identifier given to this user |
| name | String | Their full name (e.g. "John Smith") |
| String | Their email address | |
| role | String | Their role (we currently support predefined ones of: "viewer", "uploader", "admin" or "owner") |
| authentication | String | How the user is authenticated (either "password" or "sso") |
| notifications | Array | An array of strings listing the events to email the user about |
| enabled | Boolean | A user can be temporarily disabled so that they can't sign in, but do still exist |
| mfa_required | Boolean | If they have enabled MFA (2FA), meaning they need to enter a code in additiion to their password |
| verified_email | Boolean | We send a link to click to verify they own the email address entered and so manage this value internally |
| created_by | String | The ID of the user who created it (if known) |
| created_time | String | The date and time it was created |
| updated_by | String | The ID of the user who last modified it (if known) |
| updated_time | String | The date and time it was last modified |
Update a user
PATCH /users/:id
PATCH /users/:id
The body of the request should contain one, or more, attributes that you would like to update for the user. Please be very careful when making changes to existing items to avoid losing data, particularly if a particular key has sub-keys.
It is not currently possible to change a user's email because we need to verify an address. That is handled as part of inviting a new user and so for a user with a new email address, please send a new invite to that new address.
Example request
curl \-g \-H "Authorization: Bearer YOUR-API-KEY" \-H "Content-Type: application/json" \-X PATCH \-d '{"name":"Example User"}' \"https://api.vidbeo.com/v2/users/abcde12345abcde12345a"Example response
{ "success": true, "result": { "id": "abcde12345abcde12345a", "name": "Example User", "role": "viewer", "authentication": "password", "notifications": [], "enabled": true, "mfa_required": false, "verified_email": true, "created_by": "abcde12345abcde1234a", "created_time": "2022-01-01T00:00:00.000Z", "updated_by": "abcde12345abcde12345a", "updated_time": "2022-01-01T00:00:00.000Z" }, "links": null, "errors": []}Delete a user
DELETE /users/:id
DELETE /users/:id
Example request
curl \-H "Authorization: Bearer YOUR-API-KEY" \-X DELETE \"https://api.vidbeo.com/v2/users/abcde12345abcde12345a"Example response
{ "success": true, "result": {}, "links": null, "errors": []}