Interface UpdateSubscribeToken

Represents the changes requested for a subscribe token.

interface UpdateSubscribeToken {
    addTokenStreams?: SubscribeTokenStream[];
    isActive?: boolean;
    label?: string;
    refreshToken?: boolean;
    removeTokenStreams?: SubscribeTokenStream[];
    updateAllowedCountries?: string[];
    updateAllowedIpAddresses?: string[];
    updateAllowedOrigins?: string[];
    updateBindIpsOnUsage?: number;
    updateDeniedCountries?: string[];
    updateOriginCluster?: string;
}

Properties

addTokenStreams? isActive? label? refreshToken? removeTokenStreams? updateAllowedCountries? updateAllowedIpAddresses? updateAllowedOrigins? updateBindIpsOnUsage? updateDeniedCountries? updateOriginCluster?

Properties

Optional addTokenStreams

addTokenStreams?: SubscribeTokenStream[]

List of stream names to add to the list.

Optional isActive

isActive?: boolean

Enables or disable the publish token.

Optional label

label?: string

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

Optional refreshToken

refreshToken?: boolean

Refresh the publish token.

Optional removeTokenStreams

removeTokenStreams?: SubscribeTokenStream[]

List of stream names to remove from the list.

Optional updateAllowedCountries

updateAllowedCountries?: string[]

Update the list of allowed countries.

Optional updateAllowedIpAddresses

updateAllowedIpAddresses?: string[]

Update the list of allows IP addresses.

Optional updateAllowedOrigins

updateAllowedOrigins?: string[]

Update the list of allowed origins.

Optional updateBindIpsOnUsage

updateBindIpsOnUsage?: number

Update the bind IPs on usage value.

Optional updateDeniedCountries

updateDeniedCountries?: string[]

Update the list of denied countries.

Optional updateOriginCluster

updateOriginCluster?: string

Update the origin cluster.

Settings

Member Visibility

Theme

On This Page

addTokenStreamsisActivelabelrefreshTokenremoveTokenStreamsupdateAllowedCountriesupdateAllowedIpAddressesupdateAllowedOriginsupdateBindIpsOnUsageupdateDeniedCountriesupdateOriginCluster