API docs by Redocly

LiveSwitch Cloud API (1.0)

Download OpenAPI specification:Download

ApiKeys

/ApiKeys

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/ApiKeys

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
key
string or null

The api key.

tag
string or null

Gets or sets the tag/name of the api key.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "tag": "string",
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "tag": "string",
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ApiKeys/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "key": "string",
  • "tag": "string",
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ApiKeys/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
key
string or null

The api key.

tag
string or null

Gets or sets the tag/name of the api key.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "key": "string",
  • "tag": "string",
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ApiKeys/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

ApplicationConfigs

/ApplicationConfigs

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/ApplicationConfigs

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null

The unique id of the application, different from application id.

organizationId
string or null

The organization id.

disabled
boolean or null

Gets or sets the disabled state of the config.

tag
string or null

Gets or sets the tag/name of the config.

applicationId
string or null

The application id.

sharedSecret
string or null

The shared secret of the application.

Array of objects or null (ApplicationWebhook)

Array of webhooks that have been added to the application.

Responses

Request samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "disabled": true,
  • "tag": "string",
  • "applicationId": "string",
  • "sharedSecret": "string",
  • "webhooks": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "disabled": true,
  • "tag": "string",
  • "applicationId": "string",
  • "sharedSecret": "string",
  • "webhooks": [
    ]
}

/ApplicationConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "disabled": true,
  • "tag": "string",
  • "applicationId": "string",
  • "sharedSecret": "string",
  • "webhooks": [
    ]
}

/ApplicationConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null

The unique id of the application, different from application id.

organizationId
string or null

The organization id.

disabled
boolean or null

Gets or sets the disabled state of the config.

tag
string or null

Gets or sets the tag/name of the config.

applicationId
string or null

The application id.

sharedSecret
string or null

The shared secret of the application.

Array of objects or null (ApplicationWebhook)

Array of webhooks that have been added to the application.

Responses

Request samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "disabled": true,
  • "tag": "string",
  • "applicationId": "string",
  • "sharedSecret": "string",
  • "webhooks": [
    ]
}

/ApplicationConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

/ApplicationConfigs/{id}/GenerateToken

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
userId
string or null
deviceId
string or null
clientId
string or null
clientRoles
Array of strings or null
Array of objects or null (ChannelClaim)

Responses

Request samples

Content type
{
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "clientRoles": [
    ],
  • "channelClaims": [
    ]
}

Applications

/Applications/{id}/SendChannelMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
channelId
string or null
object (ServerMessage)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "message": {
    }
}

/Applications/{id}/SendChannelUserMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
channelId
string or null
userId
string or null
object (ServerMessage)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "message": {
    }
}

/Applications/{id}/SendChannelDeviceMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
object (ServerMessage)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "message": {
    }
}

/Applications/{id}/SendChannelClientMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
clientId
string or null
object (ServerMessage)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "message": {
    }
}

/Applications/{id}/SendApplicationMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
object (ServerMessage)

Responses

Request samples

Content type
{
  • "message": {
    }
}

/Applications/{id}/SendUserMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
object (ServerMessage)
userId
string or null

Responses

Request samples

Content type
{
  • "message": {
    },
  • "userId": "string"
}

/Applications/{id}/SendDeviceMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
object (ServerMessage)
userId
string or null
deviceId
string or null

Responses

Request samples

Content type
{
  • "message": {
    },
  • "userId": "string",
  • "deviceId": "string"
}

/Applications/{id}/SendClientMessage

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Request Body schema:
object (ServerMessage)
userId
string or null
deviceId
string or null
clientId
string or null

Responses

Request samples

Content type
{
  • "message": {
    },
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string"
}

/Applications/{id}/KickChannel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null

Responses

Request samples

Content type
{
  • "channelId": "string"
}

/Applications/{id}/KickChannelUser

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string"
}

/Applications/{id}/KickChannelDevice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string"
}

/Applications/{id}/KickChannelClient

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
clientId
string or null

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string"
}

/Applications/{id}/KickChannelConnection

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
clientId
string or null
connectionId
string or null

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "connectionId": "string"
}

/Applications/{id}/UpdateChannel

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
object (ChannelConfigUpdate)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "config": {
    }
}

/Applications/{id}/UpdateChannelUser

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
object (ChannelUserConfig)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "config": {
    }
}

/Applications/{id}/UpdateChannelDevice

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
object (ChannelDeviceConfig)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "config": {
    }
}

/Applications/{id}/UpdateChannelClient

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
clientId
string or null
object (ChannelClientConfig)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "config": {
    }
}

/Applications/{id}/UpdateChannelConnection

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelId
string or null
userId
string or null
deviceId
string or null
clientId
string or null
connectionId
string or null
object (ConnectionConfig)

Responses

Request samples

Content type
{
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "connectionId": "string",
  • "config": {
    }
}

ApplicationWebhooks

/ApplicationWebhooks

Authorizations:
ApiKeyAuth
query Parameters
applicationConfigId
string
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/ApplicationWebhooks

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
applicationConfigId
required
string
name
string or null

Gets or sets the webhook name.

url
string or null

Gets or sets the webhook URL.

disabled
boolean

Gets or sets the disabled state of the webhook.

batch
boolean

If multiple events are generated at the same time, we will send all the events together in one call to the Webhook URL instead of sending each event separately.

reliable
boolean

In case of a network error, we will try to resend the event. The maximum number of attempts we try is 3.

events
Array of strings or null

List of Webhook events that have been enabled.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "applicationConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

Response samples

Content type
application/json
{
  • "applicationConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ApplicationWebhooks/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
applicationConfigId
required
string
name
string or null

Gets or sets the webhook name.

url
string or null

Gets or sets the webhook URL.

disabled
boolean

Gets or sets the disabled state of the webhook.

batch
boolean

If multiple events are generated at the same time, we will send all the events together in one call to the Webhook URL instead of sending each event separately.

reliable
boolean

In case of a network error, we will try to resend the event. The maximum number of attempts we try is 3.

events
Array of strings or null

List of Webhook events that have been enabled.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "applicationConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ApplicationWebhooks/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

AuditLogEvents

/AuditLogEvents

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/AuditLogEvents/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "entityType": "string",
  • "entityId": "string",
  • "propertyName": "string",
  • "oldValue": "string",
  • "newValue": "string",
  • "changedOn": 0,
  • "changedBy": "string",
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

Billing

/Billing/Usage

Authorizations:
ApiKeyAuth
query Parameters
applicationId
string
startTimestamp
integer <int64>
endTimestamp
integer <int64>
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

ChannelConfigs

/ChannelConfigs

Authorizations:
ApiKeyAuth
query Parameters
applicationConfigId
string
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/ChannelConfigs

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null

The unique id of the application.

applicationConfigId
required
string

The application config id.

channelIdPattern
required
string

The channel id pattern. Example: "12345" or "*"

recordingEnabled
boolean or null

Gets or sets whether recording is enabled.

default
boolean

Gets or sets the default channel.

priority
integer <int32>
connectionStatsInterval
integer or null <int32>
bandwidthAdaptationPolicy
string (BandwidthAdaptationPolicy)
Enum: "Disabled" "Enabled"

RTP packet header Extension support policies.

object (CodecConfig)
object (SfuConfig)
object (McuConfig)
object (RtmpConfig)
object (RecordingManagementOverrideConfig)
Array of objects or null (VideoEncodingConfig) <= 3 items
Array of objects or null (ChannelWebhook)

Gets or sets the webhooks of the channel.

Responses

Request samples

Content type
{
  • "id": "string",
  • "applicationConfigId": "string",
  • "channelIdPattern": "string",
  • "recordingEnabled": true,
  • "default": true,
  • "priority": 0,
  • "connectionStatsInterval": 0,
  • "bandwidthAdaptationPolicy": "Disabled",
  • "codec": {
    },
  • "sfu": {
    },
  • "mcu": {
    },
  • "rtmp": {
    },
  • "recordingManagementOverride": {
    },
  • "videoEncodings": [
    ],
  • "webhooks": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "applicationConfigId": "string",
  • "channelIdPattern": "string",
  • "recordingEnabled": true,
  • "default": true,
  • "priority": 0,
  • "connectionStatsInterval": 0,
  • "bandwidthAdaptationPolicy": "Disabled",
  • "codec": {
    },
  • "sfu": {
    },
  • "mcu": {
    },
  • "rtmp": {
    },
  • "recordingManagementOverride": {
    },
  • "videoEncodings": [
    ],
  • "webhooks": [
    ]
}

/ChannelConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "applicationConfigId": "string",
  • "channelIdPattern": "string",
  • "recordingEnabled": true,
  • "default": true,
  • "priority": 0,
  • "connectionStatsInterval": 0,
  • "bandwidthAdaptationPolicy": "Disabled",
  • "codec": {
    },
  • "sfu": {
    },
  • "mcu": {
    },
  • "rtmp": {
    },
  • "recordingManagementOverride": {
    },
  • "videoEncodings": [
    ],
  • "webhooks": [
    ]
}

/ChannelConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null

The unique id of the application.

applicationConfigId
required
string

The application config id.

channelIdPattern
required
string

The channel id pattern. Example: "12345" or "*"

recordingEnabled
boolean or null

Gets or sets whether recording is enabled.

default
boolean

Gets or sets the default channel.

priority
integer <int32>
connectionStatsInterval
integer or null <int32>
bandwidthAdaptationPolicy
string (BandwidthAdaptationPolicy)
Enum: "Disabled" "Enabled"

RTP packet header Extension support policies.

object (CodecConfig)
object (SfuConfig)
object (McuConfig)
object (RtmpConfig)
object (RecordingManagementOverrideConfig)
Array of objects or null (VideoEncodingConfig) <= 3 items
Array of objects or null (ChannelWebhook)

Gets or sets the webhooks of the channel.

Responses

Request samples

Content type
{
  • "id": "string",
  • "applicationConfigId": "string",
  • "channelIdPattern": "string",
  • "recordingEnabled": true,
  • "default": true,
  • "priority": 0,
  • "connectionStatsInterval": 0,
  • "bandwidthAdaptationPolicy": "Disabled",
  • "codec": {
    },
  • "sfu": {
    },
  • "mcu": {
    },
  • "rtmp": {
    },
  • "recordingManagementOverride": {
    },
  • "videoEncodings": [
    ],
  • "webhooks": [
    ]
}

/ChannelConfigs/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

ChannelRecordings

Retrieves ChannelRecordings in the specified Application

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Application to retrieve ChannelRecordings from.

query Parameters
$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$top
integer <int32>

Limits the number of items returned from a collection.

$filter
string

Restricts the set of items returned. The allowed properties are: channelId (Only eq),ready (Only eq) startTimestamp (Only ge), and stopTimestamp (Only lt). No OData functions or mathematical operators are supported. Only the and logical operator is permitted.

        Examples
        
        channelId eq 'myChannelId'
        channelId eq 'myChannelId' and startTimestamp ge 2022-01-01T12:00:00Z
        channelId eq 'myChannelId' and startTimestamp ge 2022-01-01T12:00:00Z and stopTimestamp lt 2022-01-02T12:00:00Z
        channelId eq 'myChannelId' and startTimestamp ge 2022-01-01T12:00:00Z and stopTimestamp lt 2022-01-02T12:00:00Z and ready eq true
api-version
string

The requested API version

$filter
string
$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Retrieve a single ChannelRecording

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "tag": "string",
  • "applicationId": "string",
  • "channelId": "string",
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "stopTimestamp": "2019-08-24T14:15:22Z",
  • "expiryTimestamp": "2019-08-24T14:15:22Z",
  • "hasAudio": true,
  • "hasVideo": true,
  • "fileName": "string",
  • "audioFileName": "string",
  • "videoFileName": "string",
  • "fileSize": 0,
  • "audioFileSize": 0,
  • "videoFileSize": 0,
  • "ready": true,
  • "audioReady": true,
  • "videoReady": true,
  • "url": "string",
  • "audioUrl": "string",
  • "videoUrl": "string",
  • "filePath": "string",
  • "audioFilePath": "string",
  • "videoFilePath": "string",
  • "objectKey": "string",
  • "audioObjectKey": "string",
  • "videoObjectKey": "string",
  • "ingested": true,
  • "muxPending": true,
  • "movePending": true,
  • "audioMovePending": true,
  • "videoMovePending": true,
  • "muxEnabled": true,
  • "moveEnabled": true,
  • "deleteFiles": true,
  • "recordingPath": "string",
  • "muxArgs": [
    ],
  • "muxSeconds": 0,
  • "moveSeconds": 0,
  • "audioMoveSeconds": 0,
  • "videoMoveSeconds": 0,
  • "deleted": true,
  • "deletedOn": "2019-08-24T14:15:22Z",
  • "deletedBy": "27f98a93-27e2-453c-b1c3-4780c8067d7c",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": "07ff0787-1af5-4fc4-9832-7aaeaa962a5e",
  • "metadata": "string"
}

Delete a ChannelRecording

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to delete

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{ }

Retrieves ChannelRecording JSON for LS Mux

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Retrieves ChannelRecording audio URL

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Retrieves ChannelRecording video URL

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Retrieves ChannelRecording URL

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ChannelRecording belongs to

channelId
required
string

The Id of the Channel the ChannelRecording belongs to

channelRecordingId
required
string <uuid>

The GUID of the ChannelRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

ChannelWebhooks

/ChannelWebhooks

Authorizations:
ApiKeyAuth
query Parameters
channelConfigId
string
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/ChannelWebhooks

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
channelConfigId
string or null
name
string or null

Gets or sets the webhook name.

url
string or null

Gets or sets the webhook URL.

disabled
boolean

Gets or sets the disabled state of the webhook.

batch
boolean

If multiple events are generated at the same time, we will send all the events together in one call to the Webhook URL instead of sending each event separately.

reliable
boolean

In case of a network error, we will try to resend the event. The maximum number of attempts we try is 3.

events
Array of strings or null

List of Webhook events that have been enabled.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "channelConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

Response samples

Content type
application/json
{
  • "channelConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ChannelWebhooks/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
channelConfigId
string or null
name
string or null

Gets or sets the webhook name.

url
string or null

Gets or sets the webhook URL.

disabled
boolean

Gets or sets the disabled state of the webhook.

batch
boolean

If multiple events are generated at the same time, we will send all the events together in one call to the Webhook URL instead of sending each event separately.

reliable
boolean

In case of a network error, we will try to resend the event. The maximum number of attempts we try is 3.

events
Array of strings or null

List of Webhook events that have been enabled.

id
string or null
createdOn
integer <int64>
createdBy
string or null
modifiedOn
integer <int64>
modifiedBy
string or null

Responses

Request samples

Content type
{
  • "channelConfigId": "string",
  • "name": "string",
  • "url": "string",
  • "disabled": true,
  • "batch": true,
  • "reliable": true,
  • "events": [
    ],
  • "id": "string",
  • "createdOn": 0,
  • "createdBy": "string",
  • "modifiedOn": 0,
  • "modifiedBy": "string"
}

/ChannelWebhooks/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

ConnectionRecordings

Retrieves ConnectionRecordings in the specified Application

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Application to retrieve ConnectionRecordings from.

query Parameters
$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$top
integer <int32>

Limits the number of items returned from a collection.

$filter
string

Restricts the set of items returned. The allowed properties are: channelId (Only eq), userId (Only eq), deviceId (Only eq), clientId (Only eq), connectionId (Only eq), channelRecordingId (Only eq), startTimestamp (Only ge), and stopTimestamp (Only lt). No OData functions or mathematical operators are supported. Only the and logical operator is permitted.

        Examples
        
        channelId eq 'myChannelId'
        channelId eq 'myChannelId' and startTimestamp ge 2022-01-01T12:00:00Z
        channelId eq 'myChannelId' and startTimestamp ge 2022-01-01T12:00:00Z and stopTimestamp lt 2022-01-02T13:00:00Z
api-version
string

The requested API version

$filter
string
$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get a single ConnectionRecording

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ConnectionRecording belongs to

connectionRecordingId
required
string <uuid>

The Id of the ConnectionRecording

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "tag": "string",
  • "audioId": "2cd93d65-b100-4910-a381-19111c50e257",
  • "videoId": "3524e86f-1bba-489a-bf6b-386ea1abbac0",
  • "applicationId": "string",
  • "channelId": "string",
  • "userId": "string",
  • "deviceId": "string",
  • "clientId": "string",
  • "clientProtocol": "string",
  • "connectionId": "string",
  • "connectionType": "string",
  • "startTimestamp": "2019-08-24T14:15:22Z",
  • "stopTimestamp": "2019-08-24T14:15:22Z",
  • "hasAudio": true,
  • "hasVideo": true,
  • "audioFileName": "string",
  • "videoFileName": "string",
  • "audioFileSize": 0,
  • "videoFileSize": 0,
  • "audioReady": true,
  • "videoReady": true,
  • "audioUrl": "string",
  • "videoUrl": "string",
  • "audioFilePath": "string",
  • "videoFilePath": "string",
  • "audioObjectKey": "string",
  • "videoObjectKey": "string",
  • "connectionTag": "string",
  • "audioMuted": true,
  • "videoMuted": true,
  • "audioDisabled": true,
  • "videoDisabled": true,
  • "audioContent": "string",
  • "videoContent": "string",
  • "audioFirstFrameTimestamp": "2019-08-24T14:15:22Z",
  • "videoFirstFrameTimestamp": "2019-08-24T14:15:22Z",
  • "audioLastFrameTimestamp": "2019-08-24T14:15:22Z",
  • "videoLastFrameTimestamp": "2019-08-24T14:15:22Z",
  • "videoDelay": 0,
  • "ingested": true,
  • "audioMovePending": true,
  • "videoMovePending": true,
  • "audioMoveSeconds": 0,
  • "videoMoveSeconds": 0,
  • "channelRecordingId": "0d854ea2-c92a-4cab-8584-1a3e291c437f",
  • "updates": [
    ],
  • "deleted": true,
  • "deletedOn": "2019-08-24T14:15:22Z",
  • "deletedBy": "27f98a93-27e2-453c-b1c3-4780c8067d7c",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": "07ff0787-1af5-4fc4-9832-7aaeaa962a5e",
  • "metadata": "string"
}

Retrieves ConnectionRecording JSON for LS Mux

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ConnectionRecording belongs to

connectionRecordingId
required
string <uuid>

The GUID of the ConnectionRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Retrieves the audio url of the ConnectionRecording

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ConnectionRecording belongs to

connectionRecordingId
required
string <uuid>

The GUID of the ConnectionRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Retrieves the video url of the ConnectionRecording

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Id of the Application the ConnectionRecording belongs to

connectionRecordingId
required
string <uuid>

The GUID of the ConnectionRecording to retrieve

query Parameters
api-version
string

The requested API version

Responses

Response samples

Content type
application/json
{
  • "value": "string"
}

Organizations

/Organizations

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/Organizations/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userIds": [
    ],
  • "name": "string",
  • "address": {
    },
  • "primaryContact": {
    },
  • "paymentMethodId": "string",
  • "vatNumber": "string",
  • "industry": "string",
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "additionalContacts": [
    ]
}

/Organizations/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null
userIds
Array of strings or null

Array of user ids from the logged in user.

name
string or null
object (Address)
object (Contact)
paymentMethodId
string or null

Id of the user's payment method.

vatNumber
string or null
industry
string or null
createdOn
integer <int64>

Timestamp of when the user was created.

modifiedOn
integer <int64>

Timestamp of when the user was last modified.

Array of objects or null (Contact)

Responses

Request samples

Content type
{
  • "id": "string",
  • "userIds": [
    ],
  • "name": "string",
  • "address": {
    },
  • "primaryContact": {
    },
  • "paymentMethodId": "string",
  • "vatNumber": "string",
  • "industry": "string",
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "additionalContacts": [
    ]
}

PaymentMethods

/PaymentMethods

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/PaymentMethods

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null
organizationId
string or null
type
string or null
status
string or null
object (PaymentCard)
createdOn
integer <int64>
modifiedOn
integer <int64>

Responses

Request samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "type": "string",
  • "status": "string",
  • "card": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "type": "string",
  • "status": "string",
  • "card": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0
}

/PaymentMethods/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "type": "string",
  • "status": "string",
  • "card": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0
}

/PaymentMethods/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null
organizationId
string or null
type
string or null
status
string or null
object (PaymentCard)
createdOn
integer <int64>
modifiedOn
integer <int64>

Responses

Request samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "type": "string",
  • "status": "string",
  • "card": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0
}

/PaymentMethods/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Responses

Recordings

Gets the total size (in bytes) of all recordings.

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "value": 0
}

Gets the maximum size (in bytes) allowed for recordings.

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "value": 0
}

Gets the total size (in bytes) of all recordings for the specified Application.

Authorizations:
ApiKeyAuth
path Parameters
applicationId
required
string

The Application to retrieve the used size for.

query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "value": 0
}

Subscriptions

/Subscriptions

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/Subscriptions/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "organizationId": "string",
  • "status": "string",
  • "trialEndOn": 0,
  • "trialStartOn": 0,
  • "activatedOn": 0,
  • "nextBillingOn": 0,
  • "cancelledOn": 0,
  • "billingUnit": "string",
  • "cancelledReason": "string",
  • "platformPlan": {
    },
  • "supportPlan": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "currentTermEnd": 0,
  • "EnabledFeatures": [
    ]
}

/Subscriptions/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
id
string or null
organizationId
string or null

Your customer id.

status
string or null

Status of your current subscription. Example: "active", "paused", "cancelled"

trialEndOn
integer or null <int64>

Timestamp of when the subscription trial ends if applicable.

trialStartOn
integer or null <int64>

Timestamp of when the subscription trial has started if applicable.

activatedOn
integer or null <int64>

Timestamp of when the subscription was activated.

nextBillingOn
integer or null <int64>

Timestamp of when the next billing happens.

cancelledOn
integer or null <int64>

Timestamp of when the subscription was cancelled if applicable.

billingUnit
string or null

The unit of billing. Example: "month"

cancelledReason
string or null
object (PlatformPlan)
object (SupportPlan)
createdOn
integer or null <int64>
modifiedOn
integer or null <int64>
currentTermEnd
integer or null <int64>
EnabledFeatures
Array of strings or null

Responses

Request samples

Content type
{
  • "id": "string",
  • "organizationId": "string",
  • "status": "string",
  • "trialEndOn": 0,
  • "trialStartOn": 0,
  • "activatedOn": 0,
  • "nextBillingOn": 0,
  • "cancelledOn": 0,
  • "billingUnit": "string",
  • "cancelledReason": "string",
  • "platformPlan": {
    },
  • "supportPlan": {
    },
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "currentTermEnd": 0,
  • "EnabledFeatures": [
    ]
}

/Subscriptions/GetPlatformPlans

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

/Subscriptions/GetSupportPlans

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Users

/Users

Authorizations:
ApiKeyAuth
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

$filter
string

Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.

$orderby
string

Specifies the order in which items are returned. The maximum number of expressions is 5.

$top
integer <int32>

Limits the number of items returned from a collection.

$skip
integer <int32>

Excludes the specified number of items of the queried collection from the result.

$count
boolean

Indicates whether the total count of items within a collection are returned in the result.

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

/Users/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

$select
string

Limits the properties returned in the result.

$expand
string

Indicates the related entities to be represented inline. The maximum depth is 2.

Responses

Response samples

Content type
application/json
{
  • "lscAppCreated": true,
  • "lscChannelCreated": true,
  • "lscConnectionCreated": true,
  • "lastLSCAndroidDownloadDate": 0,
  • "lastLSCJavaDownloadDate": 0,
  • "lastLSCNetDownloadDate": 0,
  • "lastLSCUnityDownloadDate": 0,
  • "lastLSCHololensDownloadDate": 0,
  • "lastLSCWebDownloadDate": 0,
  • "lastLSCIosDownloadDate": 0,
  • "lastLSCMacosDownloadDate": 0,
  • "lastLSCTVosDownloadDate": 0,
  • "lastLSCUwpDownloadDate": 0,
  • "lastLSCXamarinDownloadDate": 0,
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "pictureUrl": "string",
  • "role": "string",
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "identities": [
    ]
}

/Users/{id}

Authorizations:
ApiKeyAuth
path Parameters
id
required
string
query Parameters
api-version
string

The requested API version

Request Body schema:
lscAppCreated
boolean
lscChannelCreated
boolean
lscConnectionCreated
boolean
lastLSCAndroidDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Android SDK.

lastLSCJavaDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Java SDK.

lastLSCNetDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the .Net SDK.

lastLSCUnityDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Unity SDK.

lastLSCHololensDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Hololens SDK.

lastLSCWebDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Web SDK.

lastLSCIosDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the iOS SDK.

lastLSCMacosDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the macOS SDK.

lastLSCTVosDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the tvOS SDK.

lastLSCUwpDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the UWP SDK.

lastLSCXamarinDownloadDate
integer <int64>

Timestamp of when the user has last downloaded the Xamarin SDK.

id
string or null
firstName
string or null
lastName
string or null
username
string or null
nickname
string or null
emailAddress
string or null
phoneNumber
string or null
pictureUrl
string or null
role
string or null
createdOn
integer <int64>
modifiedOn
integer <int64>
Array of objects or null (Identity)

Responses

Request samples

Content type
{
  • "lscAppCreated": true,
  • "lscChannelCreated": true,
  • "lscConnectionCreated": true,
  • "lastLSCAndroidDownloadDate": 0,
  • "lastLSCJavaDownloadDate": 0,
  • "lastLSCNetDownloadDate": 0,
  • "lastLSCUnityDownloadDate": 0,
  • "lastLSCHololensDownloadDate": 0,
  • "lastLSCWebDownloadDate": 0,
  • "lastLSCIosDownloadDate": 0,
  • "lastLSCMacosDownloadDate": 0,
  • "lastLSCTVosDownloadDate": 0,
  • "lastLSCUwpDownloadDate": 0,
  • "lastLSCXamarinDownloadDate": 0,
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "username": "string",
  • "nickname": "string",
  • "emailAddress": "string",
  • "phoneNumber": "string",
  • "pictureUrl": "string",
  • "role": "string",
  • "createdOn": 0,
  • "modifiedOn": 0,
  • "identities": [
    ]
}