logo
API docs by Redocly

Accounts

Download OpenAPI specification:Download

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Oauth 2 resource

Callback from SSO

Callback from SSO provider

query Parameters
code
required
string
state
required
string

Responses

Response samples

Content type
application/json
{ }

Login vis SSO

Initiate SSO login based on type

query Parameters
type
required
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"

Responses

Response samples

Content type
application/json
{ }

Register client

Register client with SSO provider

query Parameters
type
required
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"
secret
required
string

Responses

Response samples

Content type
application/json
{ }

Callback from SSO provider

Callback from SSO provider

query Parameters
code
required
string
state
required
string

Responses

Response samples

Content type
application/json
{ }

Get available authentication types

Get available authentication types

Responses

Response samples

Content type
application/json
{ }

NimbusGPT

NimbusGPT

Chat with NimbusGPT

Chat with NimbusGPT

query Parameters
organizationId
string
Request Body schema: application/json
required
Array
content
string
role
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Token

Token API

Get api tokens

Return api tokens

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Generate api token

Return api token

query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
assignedRoles
Array of strings unique
expiration
string <date-time>
name
string
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
permittedOrganizations
Array of strings unique
superAdmin
boolean

Responses

Request samples

Content type
application/json
{
  • "assignedRoles": [
    ],
  • "expiration": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissions": [
    ],
  • "permittedOrganizations": [
    ],
  • "superAdmin": true
}

Response samples

Content type
application/json
"string"

deleteToken

Delete api token

path Parameters
tokenId
required
string

Token id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Activate api token

Activate api token

path Parameters
tokenId
required
string

Token id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Deactivate api token

Deactivate api token

path Parameters
tokenId
required
string

Token id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Jobs

Get job

Returns queued job

path Parameters
jobId
required
string

Job id

query Parameters
providerId
string
organization
Array of strings

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Organization

Organization management

Get organizations

Get organizations, filtered by type and include disabled

query Parameters
includeDisabled
boolean

Include disabled organizations

type
string
Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Organization type

includePermissions
boolean

Include organization permission list

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new organization

Create organization

query Parameters
providerId
string
email
string
preload-content
boolean
Default: false
Request Body schema: application/json
required
object (AddressInfo)
awsMarketplaceOrganization
boolean
required
object (Billing)
object (Branding)
buildAccessEnabled
boolean
Array of objects (CloudConfigurationDTO) unique
object (ComplianceRecordingSettingsDTO)
created
string <date-time>
enabled
boolean
object (ExternalSystem)
id
string
licenseMode
string
Enum: "DEMO" "PRODUCTION"
object (MediaStoreInfo)
name
required
string
oldPlayoutNotificationEnabled
boolean
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
playoutId
string
object (ResourceLimitsDTO)
serviceProviderId
string
object (TermsAndConditionsApproval)
type
string
Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Responses

Request samples

Content type
application/json
{
  • "addressInfo": {
    },
  • "awsMarketplaceOrganization": true,
  • "billing": {
    },
  • "branding": {
    },
  • "buildAccessEnabled": true,
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "externalSystem": {
    },
  • "id": "string",
  • "licenseMode": "DEMO",
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "oldPlayoutNotificationEnabled": true,
  • "permissions": [
    ],
  • "playoutId": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "termsAndConditions": {
    },
  • "type": "NIMBUS"
}

Response samples

Content type
application/json
{ }

Search organizations

Search organizations, filtered by providerId and include disabled

query Parameters
providerId
string
isAwsMarketplace
boolean
enabledOnly
boolean
Default: true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get organization

Get organization by id

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings
includeAdditionalResources
boolean
Default: true

Responses

Response samples

Content type
application/json
{
  • "addressInfo": {
    },
  • "awsMarketplaceOrganization": true,
  • "billing": {
    },
  • "branding": {
    },
  • "buildAccessEnabled": true,
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "externalSystem": {
    },
  • "id": "string",
  • "licenseMode": "DEMO",
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "oldPlayoutNotificationEnabled": true,
  • "permissions": [
    ],
  • "playoutId": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "termsAndConditions": {
    },
  • "type": "NIMBUS"
}

Update organization

Update organization details

path Parameters
organizationId
required
string
query Parameters
providerId
string
organization
Array of strings
Request Body schema: application/json
required
object (AddressInfo)
awsMarketplaceOrganization
boolean
required
object (Billing)
object (Branding)
buildAccessEnabled
boolean
Array of objects (CloudConfigurationDTO) unique
object (ComplianceRecordingSettingsDTO)
created
string <date-time>
enabled
boolean
object (ExternalSystem)
id
string
licenseMode
string
Enum: "DEMO" "PRODUCTION"
object (MediaStoreInfo)
name
required
string
oldPlayoutNotificationEnabled
boolean
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
playoutId
string
object (ResourceLimitsDTO)
serviceProviderId
string
object (TermsAndConditionsApproval)
type
string
Enum: "NIMBUS" "CIRRUS" "STRATUS" "AD_WISE"

Responses

Request samples

Content type
application/json
{
  • "addressInfo": {
    },
  • "awsMarketplaceOrganization": true,
  • "billing": {
    },
  • "branding": {
    },
  • "buildAccessEnabled": true,
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "externalSystem": {
    },
  • "id": "string",
  • "licenseMode": "DEMO",
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "oldPlayoutNotificationEnabled": true,
  • "permissions": [
    ],
  • "playoutId": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "termsAndConditions": {
    },
  • "type": "NIMBUS"
}

Response samples

Content type
application/json
{
  • "addressInfo": {
    },
  • "awsMarketplaceOrganization": true,
  • "billing": {
    },
  • "branding": {
    },
  • "buildAccessEnabled": true,
  • "cloudConfigurations": [
    ],
  • "complianceRecordingSettings": {
    },
  • "created": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "externalSystem": {
    },
  • "id": "string",
  • "licenseMode": "DEMO",
  • "mediaStoreInfo": {
    },
  • "name": "string",
  • "oldPlayoutNotificationEnabled": true,
  • "permissions": [
    ],
  • "playoutId": "string",
  • "resourceLimits": {
    },
  • "serviceProviderId": "string",
  • "termsAndConditions": {
    },
  • "type": "NIMBUS"
}

Get organization announcements

Get organization announcements

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Post organization announcement

Post organization announcement

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings
Request Body schema: application/json
required
body
string

Announcement body

description
string

Short description of the announcment

expirationDate
string <date-time>

Announcement expiration date, in milliseconds

id
string

Announcement id

messageType
string
Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS"

Announcement message type

organizationId
string

Organization id

title
string

Announcement title

type
string
Enum: "BANNER" "MODAL" "BANNER" "MODAL"

Announcement type

Responses

Request samples

Content type
application/json
{
  • "body": "Announcement body",
  • "description": "Announcement description",
  • "expirationDate": "10000000",
  • "messageType": "BANNER",
  • "organizationId": "5c9e9b0e1c9d440000e1c9d4",
  • "title": "Announcement title",
  • "type": "INFO"
}

Response samples

Content type
application/json
{ }

Delete organization announcement

Delete organization announcement

path Parameters
organizationId
required
string
announcementId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Update organization announcement

Update organization announcement

path Parameters
organizationId
required
string
announcementId
required
string
query Parameters
organization
Array of strings
Request Body schema: application/json
required
body
string

Announcement body

description
string

Short description of the announcment

expirationDate
string <date-time>

Announcement expiration date, in milliseconds

id
string

Announcement id

messageType
string
Enum: "ERROR" "WARNING" "INFO" "SUCCESS" "INFO" "WARNING" "ERROR" "SUCCESS"

Announcement message type

organizationId
string

Organization id

title
string

Announcement title

type
string
Enum: "BANNER" "MODAL" "BANNER" "MODAL"

Announcement type

Responses

Request samples

Content type
application/json
{
  • "body": "Announcement body",
  • "description": "Announcement description",
  • "expirationDate": "10000000",
  • "messageType": "BANNER",
  • "organizationId": "5c9e9b0e1c9d440000e1c9d4",
  • "title": "Announcement title",
  • "type": "INFO"
}

Response samples

Content type
application/json
{ }

Update organization branding

Update organization branding

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings
Request Body schema: application/json
required
logo
string
title
string

Responses

Request samples

Content type
application/json
{
  • "logo": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "logo": "string",
  • "title": "string"
}

Describe available organization permissions

Gets available organization permissions

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Request playout for organization

Request playout

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Request support ticket

Request support ticket

path Parameters
organizationId
required
string
Request Body schema: application/json
required
email
string
name
string
severity
string
Enum: "LOW" "HIGH" "MEDIUM"
text
string
type
string
Enum: "INDIVIDUAL" "COMPANY"

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "name": "string",
  • "severity": "LOW",
  • "text": "string",
  • "type": "INDIVIDUAL"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Download organization terms and conditions

Download organization terms and conditions

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Accept organization terms and conditions

Accept organization terms and conditions

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Decline organization terms and conditions

Decline organization terms and conditions

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Get organization type

Get organization type by id

path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "type": "NIMBUS"
}

Get pending invitations

Get pending invitations for organization

path Parameters
organizationId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Invite new user

Invite new user to organization

path Parameters
organizationId
required
string
query Parameters
organization
Array of strings
Request Body schema: application/json
required
adwiseUser
boolean
assignedOrganizations
Array of strings unique
assignedRoles
Array of strings unique
email
required
string
nimbusUser
boolean
object (Role)
stratusUser
boolean

Responses

Request samples

Content type
application/json
{
  • "adwiseUser": true,
  • "assignedOrganizations": [
    ],
  • "assignedRoles": [
    ],
  • "email": "string",
  • "nimbusUser": true,
  • "role": {
    },
  • "stratusUser": true
}

Response samples

Content type
application/json
{ }

deleteUserInvitation_1

path Parameters
organizationId
required
string
invitationId
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Delete organization

Delete organization by id

path Parameters
organization
required
string
query Parameters
providerId
string
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Delete organization

Delete organization by id, requires password

path Parameters
organization
required
string
query Parameters
providerId
string
organization
Array of strings
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Disable organization

Disable organization by id

path Parameters
organization
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Enable organization

Enable organization by id

path Parameters
organization
required
string
query Parameters
organization
Array of strings

Responses

Response samples

Content type
application/json
{ }

Get active sessions

Gets active sessions for organization

path Parameters
organization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Providers

Service Providers API

Get service provider

Get service provider

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
{
  • "addressInfo": {
    },
  • "allowedOrganizationTypes": [
    ],
  • "authenticationTypes": [
    ],
  • "billing": {
    },
  • "buildAccessEnabled": true,
  • "cloudConfigurations": [
    ],
  • "createAdwiseOrganization": true,
  • "customDomain": "string",
  • "customOauthProviders": [
    ],
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "expirationDate": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "name": "string",
  • "organizations": [
    ],
  • "permissions": [
    ],
  • "termsAndConditions": {
    },
  • "whitelistCdrIps": [
    ]
}

Get service provider permission descriptions

Get service provider permission descriptions

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

deleteUserInvitation

path Parameters
providerId
required
string
invitationId
required
string

Responses

Response samples

Content type
application/json
{ }

Get provider oauth2 configurations

Get provider oauth2 configurations

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new service provider custom oauth2 configuration

Create new service provider custom oauth2 configuration

path Parameters
providerId
required
string
Request Body schema: application/json
required
authenticationType
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"
authorizationServerName
string
authorizationUrl
string
clientId
string
clientSecret
string
scopes
Array of strings
tenantId
string
tokenUrl
string
userInfoUrl
string

Responses

Request samples

Content type
application/json
{
  • "authenticationType": "USER_PASSWORD",
  • "authorizationServerName": "string",
  • "authorizationUrl": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "scopes": [
    ],
  • "tenantId": "string",
  • "tokenUrl": "string",
  • "userInfoUrl": "string"
}

Response samples

Content type
application/json
{
  • "authenticationType": "USER_PASSWORD",
  • "authorizationServerName": "string",
  • "authorizationUrl": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "scopes": [
    ],
  • "tenantId": "string",
  • "tokenUrl": "string",
  • "userInfoUrl": "string"
}

Delete service provider custom oauth2 configuration

Delete service provider custom oauth2 configuration

path Parameters
providerId
required
string
type
required
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Update service provider custom oauth2 configuration

Update service provider custom oauth2 configuration

path Parameters
providerId
required
string
type
required
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"
Request Body schema: application/json
required
authenticationType
string
Enum: "USER_PASSWORD" "ENTRA_ID" "OKTA"
authorizationServerName
string
authorizationUrl
string
clientId
string
clientSecret
string
scopes
Array of strings
tenantId
string
tokenUrl
string
userInfoUrl
string

Responses

Request samples

Content type
application/json
{
  • "authenticationType": "USER_PASSWORD",
  • "authorizationServerName": "string",
  • "authorizationUrl": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "scopes": [
    ],
  • "tenantId": "string",
  • "tokenUrl": "string",
  • "userInfoUrl": "string"
}

Response samples

Content type
application/json
{
  • "authenticationType": "USER_PASSWORD",
  • "authorizationServerName": "string",
  • "authorizationUrl": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "scopes": [
    ],
  • "tenantId": "string",
  • "tokenUrl": "string",
  • "userInfoUrl": "string"
}

Download service provider terms and conditions

Download service provider terms and conditions

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Accept service provider terms and conditions

Accept service provider terms and conditions

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
{ }

Decline service provider terms and conditions

Decline service provider terms and conditions

path Parameters
providerId
required
string

Responses

Response samples

Content type
application/json
{ }

Docs

Docs API

Retrieve knowledge base access token

Retrieve knowledge base access token, with location header redirect to knowledge base

query Parameters
redirect
string

Responses

Response samples

Content type
application/json
{ }

Announcements

Announcements API

Get announcements

Get system wide announcements

Responses

Response samples

Content type
application/json
{ }

Get active announcement

Get active system wide announcement

Responses

Response samples

Content type
application/json
{ }

Invoices

Invoices API

Get billing invoices

Return billing invoices that are available for given organization

query Parameters
organization
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Export billing invoice as PDF

Export billing invoice as PDF

path Parameters
documentId
required
string

Responses

Response samples

Content type
application/json
{ }

Accounts

Accounts management

Create user

Create user, returns created user

query Parameters
organization
required
Array of strings
Request Body schema: application/json
required
accountNonExpired
boolean
accountNonLocked
boolean
adwiseUser
boolean
apiUser
boolean
assignedOrganizations
Array of strings unique
assignedRoles
Array of strings unique

Assigned roles

object (BillingDTO)
cirrusUser
boolean
Deprecated
credentialsNonExpired
boolean
currentPassword
string
email
required
string
enabled
boolean
expiration
string <date-time>
externalUser
boolean
externalUserId
string
id
string
leadUser
boolean
nimbusUser
boolean
organizationId
required
string
password
required
string((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
permittedOrganizations
Array of strings unique
object (PersonalInfo)
providerId
string
ssoUser
boolean
stratusUser
boolean
useSecondaryPassword
boolean
username
required
string

Responses

Request samples

Content type
application/json
"{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"

Response samples

Content type
application/json
{ }

Update user

Update user by id, returns updated user

query Parameters
id
string
organization
Array of strings
providerId
string
Request Body schema: application/json
required
accountNonExpired
boolean
accountNonLocked
boolean
adwiseUser
boolean
apiUser
boolean
assignedOrganizations
Array of strings unique
assignedRoles
Array of strings unique

Assigned roles

object (BillingDTO)
cirrusUser
boolean
Deprecated
credentialsNonExpired
boolean
currentPassword
string
email
required
string
enabled
boolean
expiration
string <date-time>
externalUser
boolean
externalUserId
string
id
string
leadUser
boolean
nimbusUser
boolean
organizationId
required
string
password
required
string((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
permittedOrganizations
Array of strings unique
object (PersonalInfo)
providerId
string
ssoUser
boolean
stratusUser
boolean
useSecondaryPassword
boolean
username
required
string

Responses

Request samples

Content type
application/json
"{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"

Response samples

Content type
application/json
{ }

Get AWS Marketplace terms and conditions

Get AWS Marketplace terms and conditions

path Parameters
awsMarketplaceRegistrationId
required
string

Responses

Response samples

Content type
application/json
{
  • "body": "string",
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "title": "string",
  • "type": "AWS_MARKETPLACE"
}

Download AWS Marketplace terms and conditions

Download AWS Marketplace terms and conditions

path Parameters
awsMarketplaceRegistrationId
required
string
termsAndConditionsId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Validate external user

Validate external user

query Parameters
providerId
required
string
Request Body schema: application/json
required
authorizationToken
string
userId
string

Responses

Request samples

Content type
application/json
{
  • "authorizationToken": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "userName": "string"
}

Send forgot password request

Send forgot password request for user

Request Body schema: application/json
required
username
required
string

Username to reset

Responses

Request samples

Content type
application/json
{
  • "username": "username-to-reset"
}

Response samples

Content type
application/json
{ }

Get reset password data

Get reset password data by secret data hash

query Parameters
data
required
string

Responses

Response samples

Content type
application/json
{ }

Reset password

Reset password for user

query Parameters
data
required
string
Request Body schema: application/json
required
newPassword
required
string((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})

New user password

Responses

Request samples

Content type
application/json
{
  • "newPassword": "newPassword1234"
}

Response samples

Content type
application/json
{ }

Get new user registration

Get new user registration by secret data hash, returns registration data

query Parameters
data
required
string

Responses

Response samples

Content type
application/json
{ }

Register new user

Register new user using secret data hash, returns registered user

query Parameters
data
required
string
Request Body schema: application/json
required
accountNonExpired
boolean
accountNonLocked
boolean
adwiseUser
boolean
apiUser
boolean
assignedOrganizations
Array of strings unique
assignedRoles
Array of strings unique

Assigned roles

object (BillingDTO)
cirrusUser
boolean
Deprecated
credentialsNonExpired
boolean
currentPassword
string
email
required
string
enabled
boolean
expiration
string <date-time>
externalUser
boolean
externalUserId
string
id
string
leadUser
boolean
nimbusUser
boolean
organizationId
required
string
password
required
string((?=.*\d)(?=.*[a-z])(?=.*[A-Z]).{8,})
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
permittedOrganizations
Array of strings unique
object (PersonalInfo)
providerId
string
ssoUser
boolean
stratusUser
boolean
useSecondaryPassword
boolean
username
required
string

Responses

Request samples

Content type
application/json
"{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"

Response samples

Content type
application/json
"{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"

Get service provider users

Get service provider users, returns all users of service provider

query Parameters
providerId
string

Responses

Response samples

Content type
application/json
[
  • "{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"
]

Search users

Search users by organization, providerId

query Parameters
organization
Array of strings

Organization Ids

providerId
string

Responses

Response samples

Content type
application/json
[
  • "{\n \"id\": \"5c9e9b0e1c9d440000e1c9d4\",\n \"username\": \"admin\",\n \"email\": \"support@veset.tv\",\n \"password\": \"<REDACTED>\",\n"
]

Verify user

Verify user by secret data hash

query Parameters
data
required
string

Responses

Response samples

Content type
application/json
{ }

Delete user

Delete user by id

path Parameters
userId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{ }

Get two factor authentication status

Get two factor authentication status for user

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{ }

Disable two factor authentication

Disable two factor authentication for user

path Parameters
userId
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Enable two factor authentication

Enable two factor authentication for user

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{ }

Verify two factor authentication before enabling

Verify two factor authentication for user, returns backup codes

path Parameters
userId
required
string
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
{ }

Unlock user

Unlock user by id

path Parameters
userId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{ }

Maintenance

Maintenance API

Get all scheduled maintenance events

Responses

Response samples

Content type
application/json
[
  • "{\n \"description\": \"Maintenance will be performed on 2019-03-30 00:00:00\"\n \"startDate\": \"10000000\",\n \"endDate\": \"10000000\"\n}"
]

Get next maintenance event

Responses

Response samples

Content type
application/json
{ }

Roles

Roles API

Get organization security roles

Return security roles that are available for given organization

query Parameters
providerId
string
organization
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates security role

Creates and returns new security role

query Parameters
providerId
string
organization
Array of strings
Request Body schema: application/json
required
created
string <date-time>
description
string
id
string
organizationId
string
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
providerId
string
roleName
required
string
superAdmin
boolean
updated
string <date-time>
userCount
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "organizationId": "string",
  • "permissions": [
    ],
  • "providerId": "string",
  • "roleName": "string",
  • "superAdmin": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "userCount": 0
}

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "organizationId": "string",
  • "permissions": [
    ],
  • "providerId": "string",
  • "roleName": "string",
  • "superAdmin": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "userCount": 0
}

Delete security role

Deletes security role with given role name

path Parameters
roleId
required
string

Role id

query Parameters
providerId
string
organization
Array of strings
superAdmin
boolean

Responses

Response samples

Content type
application/json
{ }

Get security role with given id

Return security role with given id

path Parameters
roleId
required
string

Role id

query Parameters
providerId
string
organization
Array of strings

Responses

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "organizationId": "string",
  • "permissions": [
    ],
  • "providerId": "string",
  • "roleName": "string",
  • "superAdmin": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "userCount": 0
}

Update security role

Return security role with given role name

path Parameters
roleId
required
string

Role id

query Parameters
providerId
string
organization
Array of strings
Request Body schema: application/json
required
created
string <date-time>
description
string
id
string
organizationId
string
permissions
Array of strings unique
Items Enum: "NOOP" "INTERNAL" "PRE_AUTHORIZED" "INGEST_WORKER" "PLAYOUT_SERVICE" "VESET_ADMIN" "VESET_ADMIN_READ_ONLY" "WEBRTC_V2_ENABLED" "LIST_ORGANIZATIONS" "SWITCH_ORGANIZATION_CONTEXT" "CREATE_ORGANIZATION" "EDIT_ORGANIZATION" "DELETE_ORGANIZATION" "EDIT_GENERAL_CONFIGURATION" "VIEW_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_LIMITS" "EDIT_ORGANIZATION_DEFAULTS" "GENERATE_REPORT" "VIEW_BILLINGS" "MANAGE_ORGANIZATION_ANNOUNCEMENTS" "MANAGE_BRANDING" "MANAGE_ORGANIZATION_CUSTOM_METADATA" "MANAGE_ORGANIZATION_BLOCK_CATEGORIES" "MANAGE_SECURITY_ROLES" "VIEW_SECURITY_ROLES" "MANAGE_USERS" "VIEW_USERS" "MANAGE_INGEST_SOURCES" "ADD_REMOVE_ASSET_TAG" "VIEW_DASHBOARDS" "VIEW_INGEST" "SAVE_INGEST_QUEUE_ITEM" "DELETE_INGEST_QUEUE_ITEM" "CHANGE_QUEUE_ITEM_PRIORITY" "VIEW_LIBRARY" "MANAGE_MCP" "DOWNLOAD_ASSETS" "EDIT_ASSET_TAGS" "DELETE_ASSET" "EDIT_ASSET" "VIEW_PLAYLISTS" "CREATE_UPDATE_PLAYLIST" "DELETE_PLAYLIST" "EXPORT_PLAYLIST" "IMPORT_PLAYLIST" "VIEW_CHANNELS" "CREATE_UPDATE_CHANNEL" "CHANNEL_LOCK_OVERRIDE" "DELETE_CHANNEL" "GENERATE_TIMELINE_REPORT" "TIMELINE_CONTROL" "ASSIGN_PLAYOUT" "VIEW_PLAYOUTS" "VIEW_PLAYOUT_VERSIONS" "CREATE_PLAYOUT" "BACKUP_PLAYOUT" "EDIT_PLAYOUT" "DELETE_PLAYOUT" "LIVE_CONTROL" "VIEW_AS_RUN_LOG" "VIEW_CUSTOM_AS_RUN_LOG" "CACHE_CONTROL" "EMERGENCY_CONTROL" "MANAGE_LICENCES" "VIEW_MULTIVIEWS" "CREATE_VIEW" "EDIT_VIEW" "API" "EXTERNAL_API" "DELETE_VIEW" "VIEW_GRAPHS" "MANAGE_HLS_STEERING_CONFIGURATION" "VIEW_HLS_STEERING_CONFIGURATION" "MANAGE_GRAPHS" "MANAGE_AE_OBJECT" "MANAGE_PERMANENT_GRAPHICS" "VIEW_PLANS" "MANAGE_PLANS" "VIEW_SCHEDULING_TIMELINES" "MANAGE_SCHEDULING_TIMELINES" "VIEW_AUDIT" "MANAGE_GRAPHICS" "MANAGE_NOTIFICATIONS" "MANAGE_API_TOKENS" "VIEW_API_TOKENS" "VIEW_NOTIFICATIONS" "USE_LINUX_PLAYOUT_FEATURES" "DOWNLOAD_PLAYOUT_LOGS" "EXPORT_PLAYOUT_SETTINGS" "MANAGE_OAUTH2_CONFIG" "MANAGE_AUDIT_CONNECTORS" "VIEW_AUDIT_CONNECTORS"
providerId
string
roleName
required
string
superAdmin
boolean
updated
string <date-time>
userCount
integer <int64>

Responses

Request samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "organizationId": "string",
  • "permissions": [
    ],
  • "providerId": "string",
  • "roleName": "string",
  • "superAdmin": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "userCount": 0
}

Response samples

Content type
application/json
{
  • "created": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "organizationId": "string",
  • "permissions": [
    ],
  • "providerId": "string",
  • "roleName": "string",
  • "superAdmin": true,
  • "updated": "2019-08-24T14:15:22Z",
  • "userCount": 0
}