Invites
Manage invites using the following requests.
NOTE
There is no PATCH /invites/:id because once an invite is created, the email is immediately sent to them. So there is no opportunity to edit the sent name or email address
GET /invites
Example request
curl \
-H "Authorization: Bearer YOUR-API-KEY" \
"https://api.vidbeo.com/v2/invites"
Example response
{
"success": true,
"result": [
{
"id": "abcde12345abcde12345a",
"name": "Test User",
"email": "[email protected]",
"role": "viewer",
"authentication": "password",
"status": "pending",
"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 |
Response format
| Key | Type | Description |
|---|---|---|
| id | String | The unique identifier given to this invite |
| name | String | Their name (e.g. "John Smith") |
| String | Their email address | |
| role | String | The role to assign if accepted (we currently support predefined "viewer", "uploader", "admin" or "owner") |
| authentication | String | How the user is to be authenticated ("password" or "sso") |
| status | String | The invite is initially "pending" and moves to "acceepted" if the recipient clicks the link within it |
| 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 |
DELETE /invites/:id
Example request
curl \
-H "Authorization: Bearer YOUR-API-KEY" \
-X DELETE \
"https://api.vidbeo.com/v2/invites/abcde12345abcde12345a"
Example response
{
"success": true,
"result": {},
"links": null,
"errors": []
}
POST /invites
For security we need to verify they own the email address you provide. So we send a welcome email containing a link to click. If the invited user is set to use a password, that will also give them an opportunity to choose one.
Required parameters
You must provide the user's name, email, authentication and role.
You must specify how they are authenticated. We support values of "sso" and "password" for their authentication field. A value of "password" for that is self-explanatory. We send the invite a welcome email which lets them choose their password. A value of "sso" means they will instead use Single Sign-on (SAML2). That means they are not authenticated by us. They are authenticated using an external identity provider (such as Google or Okta) which must have been enabled for your account and previously set up. We can assist with that for our larger clients.
| Key | Type | Description |
|---|---|---|
| name | String | Their full name |
| String | Their email address | |
| role | String | The role to assign them. One of: "viewer", "uploader", "admin" or "owner" |
| authentication | String | How should we authenticate them? Either: "password" or "sso" |
Example request
curl \
-g \
-H "Authorization: Bearer YOUR-API-KEY" \
-H "Content-Type: application/json" \
-X POST \
-d '{"name":"John Smith", "email":"[email protected]", "role": "admin", "authentication":"password"}' \
"https://api.vidbeo.com/v2/invites"
Example response
{
"success": true,
"result": {
"id": "abcde12345abcde12345a",
"name": "John Smith",
"email": "[email protected]",
"role": "admin",
"authentication": "password",
"status": "pending",
"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": []
}