Invites

Invites

Manage invites using the following requests.

Return the details of recently sent invites
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

NameTypeDefaultInformation
limitString25Maximum number to return
cursorString""Used to get the next page of results: if applicable we return this as part of the links.next URL

Response format

KeyTypeDescription
idStringThe unique identifier given to this invite
nameStringTheir name (e.g. "John Smith")
emailStringTheir email address
roleStringThe role to assign if accepted (we currently support predefined "viewer", "uploader", "admin" or "owner")
authenticationStringHow the user is to be authenticated ("password" or "sso")
statusStringThe invite is initially "pending" and moves to "acceepted" if the recipient clicks the link within it
created_byStringThe ID of the user who created it (if known)
created_timeStringThe date and time it was created
updated_byStringThe ID of the user who last modified it (if known)
updated_timeStringThe date and time it was last modified
Delete an invite
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": []
}
Send an invite
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.

KeyTypeDescription
nameStringTheir full name
emailStringTheir email address
roleStringThe role to assign them. One of: "viewer", "uploader", "admin" or "owner"
authenticationStringHow 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": []
}