Interface SubscribeToken

Represents a subscribe token.

interface SubscribeToken {
    addedOn: Date;
    allowedCountries: string[];
    allowedIpAddresses: string[];
    allowedOrigins: string[];
    bindIpsOnUsage: number;
    deniedCountries: string[];
    effectiveSettings: {
        allowedCountries?: string[];
        deniedCountries?: string[];
        geoCascade: {
            clusters?: string[];
            isEnabled?: boolean;
        };
        originCluster?: string;
    };
    expiresOn?: Date;
    id: string;
    isActive: boolean;
    label: string;
    originCluster: string;
    streams: SubscribeTokenStream[];
    token: string;
    tracking: {
        trackingId?: string;
    };
}

Properties

addedOn allowedCountries allowedIpAddresses allowedOrigins bindIpsOnUsage deniedCountries effectiveSettings expiresOn? id isActive label originCluster streams token tracking

Properties

addedOn

addedOn: Date

Date when the subscribe token was created.

allowedCountries

allowedCountries: string[]

Specify the ISO 3166-1 two letter country codes to explicitly allow viewer to watch the stream from. If the viewer's location does not match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of allowed countries can be overridden by the subscribe token.

allowedIpAddresses

allowedIpAddresses: string[]

May specify multiple IPv4 addresses or CIDR notated network blocks. If specified, the token will only be usable from those IP addresses.

allowedOrigins

allowedOrigins: string[]

If specified only the domains in list will be allowed in requests to Director API with token. Wildcard subdomains are also allowed, e.g.: "*.demo.com". When unspecified (empty list) there are no domain restrictions.

bindIpsOnUsage

bindIpsOnUsage: number

If specified will bind the token to the first X IP addresses used with token in requests to Director API, thus restricting the token to those IP addresses without being known beforehand.

deniedCountries

deniedCountries: string[]

Specify the ISO 3166-1 two letter country codes to explicitly deny viewer to watch the stream from. If the viewer's location does match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of denied countries can be overridden by the subscribe token.

effectiveSettings

effectiveSettings: {
    allowedCountries?: string[];
    deniedCountries?: string[];
    geoCascade: {
        clusters?: string[];
        isEnabled?: boolean;
    };
    originCluster?: string;
}

Token effective settings for properties that use account default settings. Value for each property will either be token or account level settings.

Type declaration

  • Optional allowedCountries?: string[]

    Specify the ISO 3166-1 two letter country codes to explicitly allow viewer to watch the stream from. If the viewer's location does not match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of allowed countries can be overridden by the subscribe token.

  • Optional deniedCountries?: string[]

    Specify the ISO 3166-1 two letter country codes to explicitly deny viewer to watch the stream from. If the viewer's location does match any of the specified countries, they will be blocked from viewing stream, else they will be allowed to view stream. This geo-fencing rule works in concert with the IP and domain restrictions as well. Specifying geo restriction rules in a token will override account-wide rules. Only one of allowedCountries or deniedCountries should be specified. If the specified streams require authentication, the list of denied countries can be overridden by the subscribe token.

  • geoCascade: {
        clusters?: string[];
        isEnabled?: boolean;
    }

    Geo cascade settings for cascading stream to other clusters.

    • Optional clusters?: string[]

      List of cluster IDs to geo cascade subscribe stream. Cannot be empty when isEnabled is true. This list is ignored when isEnabled is set to false.

      Default Value

      Defaults to ["all"] if unset.

    • Optional isEnabled?: boolean

      Enable or Disable geo cascade.

      Default Value

      Defaults to Account settings if unset for subscribe token.
  • Optional originCluster?: string

    Cluster to route specified streams to.

Optional expiresOn

expiresOn?: Date

Date at which the subscribe token expires.

id

id: string

Identifier of the subscribe token.

isActive

isActive: boolean

Is the subscribe token active or not.

label

label: string

Name for the token that is used to display in the dashboard.

originCluster

originCluster: string

Cluster to route specified streams to.

streams

streams: SubscribeTokenStream[]

List of stream names.

token

token: string

Subscribe token.

tracking

tracking: {
    trackingId?: string;
}

Tracking information.

Type declaration

  • Optional trackingId?: string

    Tracking identifier for Stream Syndication.

Settings

Member Visibility

Theme

On This Page

addedOnallowedCountriesallowedIpAddressesallowedOriginsbindIpsOnUsagedeniedCountrieseffectiveSettingsexpiresOnidisActivelabeloriginClusterstreamstokentracking