Amazon Managed Grafana · JSON Structure

Amazon Managed Grafana Authentication Description Structure

A structure containing information about the user authentication methods used by the workspace.

Type: object Properties: 3 Required: 1
DashboardsMonitoringObservabilityVisualization

AuthenticationDescription is a JSON Structure definition published by Amazon Managed Grafana, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

awsSso providers saml

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-grafana/refs/heads/main/json-structure/amazon-managed-grafana-authentication-description-structure.json",
  "name": "AuthenticationDescription",
  "description": "A structure containing information about the user authentication methods used by the workspace.",
  "type": "object",
  "properties": {
    "awsSso": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsSsoAuthentication"
        },
        {
          "description": "A structure containing information about how this workspace works with IAM Identity Center. "
        }
      ]
    },
    "providers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationProviders"
        },
        {
          "description": "Specifies whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace."
        }
      ]
    },
    "saml": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamlAuthentication"
        },
        {
          "description": "A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace. "
        }
      ]
    }
  },
  "required": [
    "providers"
  ]
}