@dolbyio/dolbyio-rest-apis-client - v5.1.1
    Preparing search index...

    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 };
    }
    Index

    Properties

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

    Properties

    addedOn: Date

    Date when the subscribe token was created.

    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: string[]

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

    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: 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: 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: {
        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

    • OptionalallowedCountries?: 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.

    • OptionaldeniedCountries?: 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.

      • Optionalclusters?: 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.

        Defaults to ["all"] if unset.

      • OptionalisEnabled?: boolean

        Enable or Disable geo cascade.

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

      Cluster to route specified streams to.

    expiresOn?: Date

    Date at which the subscribe token expires.

    id: string

    Identifier of the subscribe token.

    isActive: boolean

    Is the subscribe token active or not.

    label: string

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

    originCluster: string

    Cluster to route specified streams to.

    streams: SubscribeTokenStream[]

    List of stream names.

    token: string

    Subscribe token.

    tracking: { trackingId?: string }

    Tracking information.

    Type Declaration

    • OptionaltrackingId?: string

      Tracking identifier for Stream Syndication.

    Settings

    Member Visibility

    On This Page

    Properties