sharing

Documentation

Index

• Variables
• type AnonymousAccess
  • func (me *AnonymousAccess) IsEmpty() bool
  • func (me *AnonymousAccess) MarshalHCL(properties hcl.Properties) error
  • func (me *AnonymousAccess) Schema() map[string]*schema.Schema
  • func (me *AnonymousAccess) UnmarshalHCL(decoder hcl.Decoder) error
• type DashboardSharing
  • func (me *DashboardSharing) MarshalHCL(properties hcl.Properties) error
  • func (me *DashboardSharing) Schema() map[string]*schema.Schema
  • func (me *DashboardSharing) UnmarshalHCL(decoder hcl.Decoder) error
• type Permission
• type PermissionType
• type SharePermission
  • func (me *SharePermission) MarshalHCL(properties hcl.Properties) error
  • func (me *SharePermission) Schema() map[string]*schema.Schema
  • func (me *SharePermission) UnmarshalHCL(decoder hcl.Decoder) error
• type SharePermissions
  • func (me SharePermissions) MarshalHCL(properties hcl.Properties) error
  • func (me *SharePermissions) Schema() map[string]*schema.Schema
  • func (me *SharePermissions) UnmarshalHCL(decoder hcl.Decoder) error

Variables

var PermissionTypes = struct {
	All   PermissionType
	Group PermissionType
	User  PermissionType
}{
	All:   PermissionType("ALL"),
	Group: PermissionType("GROUP"),
	User:  PermissionType("USER"),
}

var Permissions = struct {
	Edit Permission
	View Permission
}{
	Edit: Permission("EDIT"),
	View: Permission("VIEW"),
}

Types

type AnonymousAccess

type AnonymousAccess struct {
	ManagementZoneIDs []string `json:"managementZoneIds"` // A list of management zones that can display data on the publicly shared dashboard. \n\nSpecify management zone IDs here. For each management zone you specify Dynatrace generates an access link. You can access them in the **urls** list. \n\nTo share the dashboard with its default management zone, use the `default` value
	// READ ONLY
	URLs map[string]string `json:"urls,omitempty"` // A list of URLs for anonymous access to the dashboard. \n\nEach link grants access to data from the specific management zone, listed in the in the **managementZoneIds** list. \n\nThese links are automatically generated by Dynatrace, you can't change them
}

AnonymousAccess represents configuration of the [anonymous access](https://dt-url.net/ov03sf1) to the dashboard

func (*AnonymousAccess) IsEmpty

func (me *AnonymousAccess) IsEmpty() bool

func (*AnonymousAccess) MarshalHCL

func (me *AnonymousAccess) MarshalHCL(properties hcl.Properties) error

func (*AnonymousAccess) Schema

func (me *AnonymousAccess) Schema() map[string]*schema.Schema

func (*AnonymousAccess) UnmarshalHCL

func (me *AnonymousAccess) UnmarshalHCL(decoder hcl.Decoder) error

type DashboardSharing

type DashboardSharing struct {
	DashboardID  string           `json:"id"`           // The Dynatrace entity ID of the dashboard
	Permissions  SharePermissions `json:"permissions"`  // Access permissions of the dashboard
	PublicAccess *AnonymousAccess `json:"publicAccess"` // Configuration of the [anonymous access](https://dt-url.net/ov03sf1) to the dashboard
	Preset       bool             `json:"preset"`       // If `true` the dashboard will be marked as preset
	Enabled      bool             `json:"enabled"`      // The dashboard is shared (`true`) or private (`false`)

	// not part of payload - used by export
	Name string `json:"-"`
}

DashboardSharing represents sharing configuration of the dashboard

func (*DashboardSharing) MarshalHCL

func (me *DashboardSharing) MarshalHCL(properties hcl.Properties) error

MarshalHCL has no documentation

func (*DashboardSharing) Schema

func (me *DashboardSharing) Schema() map[string]*schema.Schema

func (*DashboardSharing) UnmarshalHCL

func (me *DashboardSharing) UnmarshalHCL(decoder hcl.Decoder) error

UnmarshalHCL has no documentation

type Permission

type Permission string

type PermissionType

type PermissionType string

type SharePermission

type SharePermission struct {
	ID         *string        `json:"id,omitempty"` // The ID of the user or group to whom the permission is granted.\n\nNot applicable if the **type** is set to `ALL`
	Type       PermissionType `json:"type"`         // The type of the permission: \n\n* `USER`: The dashboard is shared with the specified user. \n* `GROUP`: The dashboard is shared with all users of the specified group. \n* `ALL`: The dashboard is shared via link. Any authenticated user with the link can view the dashboard
	Permission Permission     `json:"permission"`   // The level of the permission: \n \n* `VIEW`: The dashboard is shared with read permission. \n* `EDIT`: The dashboard is shared with edit permission
}

SharePermission represents access permissions of the dashboard

func (*SharePermission) MarshalHCL

func (me *SharePermission) MarshalHCL(properties hcl.Properties) error

MarshalHCL has no documentation

func (*SharePermission) Schema

func (me *SharePermission) Schema() map[string]*schema.Schema

func (*SharePermission) UnmarshalHCL

func (me *SharePermission) UnmarshalHCL(decoder hcl.Decoder) error

UnmarshalHCL has no documentation

type SharePermissions

type SharePermissions []*SharePermission

func (SharePermissions) MarshalHCL

func (me SharePermissions) MarshalHCL(properties hcl.Properties) error

MarshalHCL has no documentation

func (*SharePermissions) Schema

func (me *SharePermissions) Schema() map[string]*schema.Schema

func (*SharePermissions) UnmarshalHCL

func (me *SharePermissions) UnmarshalHCL(decoder hcl.Decoder) error

UnmarshalHCL has no documentation