workspace

Documentation

Index

• type AssertionAttributes
  • func (strct *AssertionAttributes) MarshalJSON() ([]byte, error)
  • func (strct *AssertionAttributes) UnmarshalJSON(b []byte) error
• type IdpMetadata
  • func (strct *IdpMetadata) MarshalJSON() ([]byte, error)
  • func (strct *IdpMetadata) UnmarshalJSON(b []byte) error
• type Resource
  • func (strct *Resource) MarshalJSON() ([]byte, error)
  • func (strct *Resource) UnmarshalJSON(b []byte) error
• type RoleValues
  • func (strct *RoleValues) MarshalJSON() ([]byte, error)
  • func (strct *RoleValues) UnmarshalJSON(b []byte) error
• type SamlConfiguration
  • func (strct *SamlConfiguration) MarshalJSON() ([]byte, error)
  • func (strct *SamlConfiguration) UnmarshalJSON(b []byte) error

Types

type AssertionAttributes

type AssertionAttributes struct {

	// Name of the attribute within the SAML assert to use as the users email in Grafana.
	Email string `json:"Email,omitempty"`

	// Name of the attribute within the SAML assert to use as the users groups in Grafana.
	Groups string `json:"Groups,omitempty"`

	// Name of the attribute within the SAML assert to use as the users login handle in Grafana.
	Login string `json:"Login,omitempty"`

	// Name of the attribute within the SAML assert to use as the users name in Grafana.
	Name string `json:"Name,omitempty"`

	// Name of the attribute within the SAML assert to use as the users organizations in Grafana.
	Org string `json:"Org,omitempty"`

	// Name of the attribute within the SAML assert to use as the users roles in Grafana.
	Role string `json:"Role,omitempty"`
}

AssertionAttributes Maps Grafana friendly names to the IdPs SAML attributes.

func (*AssertionAttributes) MarshalJSON

func (strct *AssertionAttributes) MarshalJSON() ([]byte, error)

func (*AssertionAttributes) UnmarshalJSON

func (strct *AssertionAttributes) UnmarshalJSON(b []byte) error

type IdpMetadata

type IdpMetadata struct {

	// URL that vends the IdPs metadata.
	Url string `json:"Url,omitempty"`

	// XML blob of the IdPs metadata.
	Xml string `json:"Xml,omitempty"`
}

IdpMetadata IdP Metadata used to configure SAML authentication in Grafana.

func (*IdpMetadata) MarshalJSON

func (strct *IdpMetadata) MarshalJSON() ([]byte, error)

func (*IdpMetadata) UnmarshalJSON

func (strct *IdpMetadata) UnmarshalJSON(b []byte) error

type Resource

type Resource struct {
	AccountAccessType string `json:"AccountAccessType,omitempty"`

	// List of authentication providers to enable.
	AuthenticationProviders []string `json:"AuthenticationProviders,omitempty"`

	// A unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
	ClientToken string `json:"ClientToken,omitempty"`

	// Timestamp when the workspace was created.
	CreationTimestamp string `json:"CreationTimestamp,omitempty"`

	// List of data sources on the service managed IAM role.
	DataSources []string `json:"DataSources,omitempty"`

	// Description of a workspace.
	Description string `json:"Description,omitempty"`

	// Endpoint for the Grafana workspace.
	Endpoint string `json:"Endpoint,omitempty"`

	// Version of Grafana the workspace is currently using.
	GrafanaVersion string `json:"GrafanaVersion,omitempty"`

	// The id that uniquely identifies a Grafana workspace.
	Id string `json:"Id,omitempty"`

	// Timestamp when the workspace was last modified
	ModificationTimestamp string `json:"ModificationTimestamp,omitempty"`

	// The user friendly name of a workspace.
	Name string `json:"Name,omitempty"`

	// List of notification destinations on the customers service managed IAM role that the Grafana workspace can query.
	NotificationDestinations []string `json:"NotificationDestinations,omitempty"`

	// The name of an IAM role that already exists to use with AWS Organizations to access AWS data sources and notification channels in other accounts in an organization.
	OrganizationRoleName string `json:"OrganizationRoleName,omitempty"`

	// List of Organizational Units containing AWS accounts the Grafana workspace can pull data from.
	OrganizationalUnits []string `json:"OrganizationalUnits,omitempty"`
	PermissionType      string   `json:"PermissionType,omitempty"`

	// IAM Role that will be used to grant the Grafana workspace access to a customers AWS resources.
	RoleArn                 string             `json:"RoleArn,omitempty"`
	SamlConfiguration       *SamlConfiguration `json:"SamlConfiguration,omitempty"`
	SamlConfigurationStatus string             `json:"SamlConfigurationStatus,omitempty"`

	// The client ID of the AWS SSO Managed Application.
	SsoClientId string `json:"SsoClientId,omitempty"`

	// The name of the AWS CloudFormation stack set to use to generate IAM roles to be used for this workspace.
	StackSetName string `json:"StackSetName,omitempty"`
	Status       string `json:"Status,omitempty"`
}

Resource Definition of AWS::Grafana::Workspace Resource Type

func (*Resource) MarshalJSON

func (strct *Resource) MarshalJSON() ([]byte, error)

func (*Resource) UnmarshalJSON

func (strct *Resource) UnmarshalJSON(b []byte) error

type RoleValues

type RoleValues struct {

	// List of SAML roles which will be mapped into the Grafana Admin role.
	Admin []string `json:"Admin,omitempty"`

	// List of SAML roles which will be mapped into the Grafana Editor role.
	Editor []string `json:"Editor,omitempty"`
}

RoleValues Maps SAML roles to the Grafana Editor and Admin roles.

func (*RoleValues) MarshalJSON

func (strct *RoleValues) MarshalJSON() ([]byte, error)

func (*RoleValues) UnmarshalJSON

func (strct *RoleValues) UnmarshalJSON(b []byte) error

type SamlConfiguration

type SamlConfiguration struct {

	// List of SAML organizations allowed to access Grafana.
	AllowedOrganizations []string             `json:"AllowedOrganizations,omitempty"`
	AssertionAttributes  *AssertionAttributes `json:"AssertionAttributes,omitempty"`
	IdpMetadata          *IdpMetadata         `json:"IdpMetadata"`

	// The maximum lifetime an authenticated user can be logged in (in minutes) before being required to re-authenticate.
	LoginValidityDuration float64     `json:"LoginValidityDuration,omitempty"`
	RoleValues            *RoleValues `json:"RoleValues,omitempty"`
}

SamlConfiguration SAML configuration data associated with an AMG workspace.

func (*SamlConfiguration) MarshalJSON

func (strct *SamlConfiguration) MarshalJSON() ([]byte, error)

func (*SamlConfiguration) UnmarshalJSON

func (strct *SamlConfiguration) UnmarshalJSON(b []byte) error