vidinfra
  1. Organization's invitations
vidinfra
  • Documentation
    • Guides
      • Welcome
      • Getting Started
        • What is Vidinfra?
        • Quick Start Guide
        • Publish First Video
        • FAQs
      • Upload & Import Videos
        • Upload from Device
        • Import from Vimeo
        • Import from YouTube
        • Import from Zoom
      • DRM
        • Widevine DRM
        • FairPlay DRM
      • Accounts
        • Accounts
      • Organization Settings
        • User Management
        • Billing
        • Settings
  • API Reference
    • Projects
      • Get projects list
      • Get project
      • Create New Project
      • Destory Project
      • Update project
      • upload logo
      • Get Project Settings
      • Upsert Project Settings
    • importer.vidinfra.com
      • welcome
      • Debug
      • test
    • Auth
      • User Registration
      • User Login
      • Verify-email
      • Forgot Password
      • Forgot Password Verify OTP
      • Forgot Password Set
      • Resend OTP
      • Logout
      • Set Password
      • Check Account exists
      • Update Password
      • Google Oauth Redirect
      • Google Oauth Callback
      • api-access-check
      • New Auth token using Refresh token
      • Github Oauth Redirect
      • Google Oauth Callback Copy
      • Get User Sessions
      • Delete User Sessions
    • User
      • Profiles
      • Profile Updates
      • Profile Avatar update
    • Organization
      • List organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Switch an organization
    • Organization's invitations
      • Sent invitation list
        GET
      • Send invitation
        POST
      • Show Token
        GET
      • Accept Invitation
        POST
      • Reject Invitation
        POST
    • Audits
      • Audits
    • Members
      • Members
      • test permission
    • API Keys
      • Get All API keys
      • Get API Key
      • Create API Keys
      • Destory API Keys
      • api key middleware (test)
    • Folders
      • Get All Folders
      • Create Folder
      • Get Folder by ID
      • Update Folder
      • Move Folder
      • Bulk Move Folders (empty)
      • Delete Folder
      • Get Folder Tree
    • Videos
      • Get All video of a project
      • Get a Video
      • Get Video using Custom field
      • create video
      • Upload thumbnail
      • Update video
      • Destroy video
      • Search Video
      • batch video Assign to collecition
      • Mark Thumbnail As Default
      • Get Video Timelines
    • Video Metas
      • Create or Update Video Meta Data
      • Get All Meta Data of a Video
    • Video Captions
      • create video caption
      • Delete a video Caption
      • Get video caption
    • Video Chapter
      • create video chapters
    • Uploads
    • Tags
      • Get all tags upder a project
      • Create Tag
      • Delete tag
    • Players
      • Get all Players
      • Create Player
      • Get Specific player
      • update player
      • Delete Player
      • Player Mark as default
    • Webhook Endpoints
      • Get webhook
      • create web hook
      • GET Webhook by ID
      • Update webhook
      • Delete web hook
    • Advertisements
      • get all ads
      • create ads
      • get single advertisement
      • Update ads
      • Delete ads
    • Webhook Event Logs
      • Get webhook event logs
      • Resend Webhook event by Id
      • Resend All Webhook Event
    • Analytics Direct Api
      • geo-distribution
      • Project Views
      • avg video watch
      • Total watch Time
      • Project Avg Watch per Unique user
      • Total Player Error
      • project popularity-analysis
      • Project Collection Insights
      • Collection Views
      • Collection avg Watch time
      • Collection Avg Watch per unique user
      • Collection Geo Distribution
      • Get all Users
      • User media views
      • User Avg video watch
      • user Player log
      • user sessions
      • Get all Video
      • video Player error
      • Video View
      • video Geo Distribution
      • video Avg watch
      • copy
    • Streams
      • Create livestream
      • Get all stream
      • Get a livestream
      • update status of livestream
      • delete a stream
      • get livestream historys
    • Stream Metas
    • Usages
      • Bandwidth Usage
      • Storage Usage
      • Get Over Usage
    • Encoding profile
      • Get all profiles
      • Create profile
      • Get A profile
      • Update a encoding profile
      • Delete a encoding profile
      • Make a profile default
    • Project Matrics
      • Get Matrics
      • project Usages
    • Access Control
      • Put Access Control
      • Get access Control
    • Analytics
      • Project Get geo-distribution
      • project views
      • Project avg video watch
      • Project Total Watch
      • Project Avg Watch per Unique user
      • Project All Player Errors
      • Project Popularity Analysis
      • Project Collections insights
      • Collection Geo Distribution
      • Collection avg watch time
      • Collection avg watch per unique User
      • Collection Player error
      • Video Geo Distribution
      • Video views
      • Video Avg Watch
      • Video Player Log
      • User
      • User Avg Video Watch
      • User Total Watch
      • User player error log
    • Plan
      • public plans
      • current plan
      • Account Plans
      • Get plan by ID
      • Admin Get Plans
      • Admin Create plan
      • Admin Get Plan by ID
      • Admin Update Plan by ID
      • Admin Delete plan By ID
      • Admin Get Plan Metrices
      • Admin Get Plan Metrices By Type
      • Admin Create Plan Matrices By Type
      • Admin Update Plan Metrices By ID
    • Upload Tokens
      • Obtain credentials before upload
    • subscribe
      • stripe redirect subscription
        • create checkout session
        • over usage payment
      • current subscription
      • discribe a plan by planCode
      • subscribe
      • cancel subscription
      • over usage payment
      • Stripe over usage autopay payment (test)
    • Transaction
      • Get All Transaction
    • Invoice
      • Get All Invoices
      • Get Invoice by ID
    • vimeo video importer
      • vimeo job list
      • Vimeo videos by migration id
      • Vimeo Set video importer
      • Vimeo sync import
      • Vimeo import videos
      • Get pull videos
      • pull video from url
    • test
      • Welcome to vidinfra Copy
      • metrics
    • transcoding service
      • get all jobs
      • get a job
      • create jobs
      • Update a job
      • Delete a job
      • create job v2
    • transcoding service v2
      • create jobs
      • get all jobs
      • get a job
      • Update a job
      • Delete a job
    • Welcome to vidinfra
      GET
    • health check
      GET
    • Regions List
      GET
    • key
      POST
    • Untitled Endpoint
      GET
  1. Organization's invitations

Send invitation

Developing
POST
/members/invitations
Send invitation to a specific user
📣 this endpoint sends invitation to a specific user by email address .In the POST Request user sends invitation with email , a list of permissions and invitation validation duration
✳ list of JSON Payload
email = email address
permissions = list of permissions
validity = invitation validation duration
📢 Info message : Here URL is contructed like
POST /account/users/invitations

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/json
email
string 
required
permissions
array [object {5}] 
required
entity_id
string 
required
entity_type
string 
required
name
string 
required
action
string 
required
permission
array [object {3}] 
required
Example
{
   "email": "rakajui@gmail.com",
    "permissions" : [
    {
      "entity_id": "d932c659-7ae8-4c84-aad5-8e23b275947d",
      "entity_type": "projects",
      "name": "full-access",
      "action": "write+read+delete",
      "permission": []
    },
    {
      "entity_id": "ab262a90-3e1d-4a71-ac52-b0c76d7af467",
      "entity_type": "organizations",
      "name": "billing",
      "action": "",
      "permission": []
    },
    {
      "entity_id": "ab262a90-3e1d-4a71-ac52-b0c76d7af467",
      "entity_type": "organizations",
      "name": "api",
      "action": "write+read",
      "permission": []
    }
  ]
  ////////////////////////////////////////////////////////////////////
  // "permissions": [
  //   {
  //     "entity_id": "f32a0116-fe11-454c-8e6a-5ff4101882e5",
  //     "entity_type": "projects",
  //     "name": "custom",
  //     "action": "",
  //     "permission": [
  //       {
  //         "action": "custom",
  //         "folders": [
  //           {
  //             "action": "write+read+delete",
  //             "folder_id": "6e4f9469-fbbe-48c7-adb4-9f67ea3bac1a"
  //           }
  //         ],
  //         "name": "folders"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "livestreams"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "analytics"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "advertisements"
  //       },
  //       {
  //         "action": "write+read",
  //         "name": "settings"
  //       }
  //     ]
  //   },

  //   {
  //     "entity_id": "0a4a7720-c50d-475d-b4af-4a58f3847d7d",
  //     "entity_type": "organizations",
  //     "name": "billing",
  //     "action": "write+read",
  //     "permission": []
  //   },
  //   {
  //     "entity_id": "0a4a7720-c50d-475d-b4af-4a58f3847d7d",
  //     "entity_type": "organizations",
  //     "name": "api",
  //     "action": "write+read",
  //     "permission": []
  //   }
  // ]  

}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:8080/v1/members/invitations' \
--header 'Content-Type: application/json' \
--data-raw '{
   "email": "rakajui@gmail.com",
    "permissions" : [
    {
      "entity_id": "d932c659-7ae8-4c84-aad5-8e23b275947d",
      "entity_type": "projects",
      "name": "full-access",
      "action": "write+read+delete",
      "permission": []
    },
    {
      "entity_id": "ab262a90-3e1d-4a71-ac52-b0c76d7af467",
      "entity_type": "organizations",
      "name": "billing",
      "action": "",
      "permission": []
    },
    {
      "entity_id": "ab262a90-3e1d-4a71-ac52-b0c76d7af467",
      "entity_type": "organizations",
      "name": "api",
      "action": "write+read",
      "permission": []
    }
  ]
  ////////////////////////////////////////////////////////////////////
  // "permissions": [
  //   {
  //     "entity_id": "f32a0116-fe11-454c-8e6a-5ff4101882e5",
  //     "entity_type": "projects",
  //     "name": "custom",
  //     "action": "",
  //     "permission": [
  //       {
  //         "action": "custom",
  //         "folders": [
  //           {
  //             "action": "write+read+delete",
  //             "folder_id": "6e4f9469-fbbe-48c7-adb4-9f67ea3bac1a"
  //           }
  //         ],
  //         "name": "folders"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "livestreams"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "analytics"
  //       },
  //       {
  //         "action": "write+read+delete",
  //         "name": "advertisements"
  //       },
  //       {
  //         "action": "write+read",
  //         "name": "settings"
  //       }
  //     ]
  //   },

  //   {
  //     "entity_id": "0a4a7720-c50d-475d-b4af-4a58f3847d7d",
  //     "entity_type": "organizations",
  //     "name": "billing",
  //     "action": "write+read",
  //     "permission": []
  //   },
  //   {
  //     "entity_id": "0a4a7720-c50d-475d-b4af-4a58f3847d7d",
  //     "entity_type": "organizations",
  //     "name": "api",
  //     "action": "write+read",
  //     "permission": []
  //   }
  // ]  

}'

Responses

🟢200OK
application/json
Body
object {0}
Example
{}
🟠400Bad Request
🟢201Created
Previous
Sent invitation list
Next
Show Token
Built with