SamlConfiguration

A structure containing information about how this workspace works with SAML.

DashboardsMonitoringObservabilityVisualization

Properties

Name Type Description
allowedOrganizations object
assertionAttributes object
idpMetadata object
loginValidityDuration object
roleValues object
View JSON Schema on GitHub

JSON Schema

amazon-managed-grafana-saml-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-managed-grafana/refs/heads/main/json-schema/amazon-managed-grafana-saml-configuration-schema.json",
  "title": "SamlConfiguration",
  "description": "A structure containing information about how this workspace works with SAML. ",
  "type": "object",
  "properties": {
    "allowedOrganizations": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AllowedOrganizations"
        },
        {
          "description": "Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access."
        }
      ]
    },
    "assertionAttributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AssertionAttributes"
        },
        {
          "description": "A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace."
        }
      ]
    },
    "idpMetadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdpMetadata"
        },
        {
          "description": "A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace."
        }
      ]
    },
    "loginValidityDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoginValidityDuration"
        },
        {
          "description": "How long a sign-on session by a SAML user is valid, before the user has to sign on again."
        }
      ]
    },
    "roleValues": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleValues"
        },
        {
          "description": "A structure containing arrays that map group names in the SAML assertion to the Grafana <code>Admin</code> and <code>Editor</code> roles in the workspace."
        }
      ]
    }
  },
  "required": [
    "idpMetadata"
  ]
}