Class SecureEmbedCreateResponseAttributes

Attributes of a newly created secure embed shared dashboard.

Hierarchy

  • SecureEmbedCreateResponseAttributes

Constructors

constructor

Properties

additionalProperties? createdAt? credential? dashboardId? globalTime? globalTimeSelectable? id? selectableTemplateVars? shareType? status? title? token? url? viewingPreferences?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional createdAt

createdAt?: string

Creation timestamp.

Optional credential

credential?: string

The secret credential used for HMAC signing. Returned only on creation. Store securely — it cannot be retrieved again.

Optional dashboardId

dashboardId?: string

The source dashboard ID.

Optional globalTime

globalTime?: SecureEmbedGlobalTime

Default time range configuration for the secure embed.

Optional globalTimeSelectable

globalTimeSelectable?: boolean

Whether time range is viewer-selectable.

Optional id

id?: string

Internal share ID.

Optional selectableTemplateVars

selectableTemplateVars?: SecureEmbedSelectableTemplateVariable[]

Template variables with their configuration.

Optional shareType

shareType?: SecureEmbedShareType

The type of share. Always secure_embed.

Optional status

status?: SecureEmbedStatus

The status of the secure embed share. Active means the shared dashboard is available. Paused means it is not.

Optional title

title?: string

Display title.

Optional token

token?: string

Public share token.

Optional url

url?: string

CDN URL for the shared dashboard.

Optional viewingPreferences

viewingPreferences?: SecureEmbedViewingPreferences

Display settings for the secure embed shared dashboard.

Settings

Member Visibility

Theme

Generated using TypeDoc