UpdateWorkspaceAuthenticationRequest

UpdateWorkspaceAuthenticationRequest schema from Amazon Managed Grafana API

DashboardsMonitoringObservabilityVisualization

Properties

Name Type Description
authenticationProviders object
samlConfiguration object
View JSON Schema on GitHub

JSON Schema

amazon-managed-grafana-update-workspace-authentication-request-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-update-workspace-authentication-request-schema.json",
  "title": "UpdateWorkspaceAuthenticationRequest",
  "description": "UpdateWorkspaceAuthenticationRequest schema from Amazon Managed Grafana API",
  "type": "object",
  "properties": {
    "authenticationProviders": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AuthenticationProviders"
        },
        {
          "description": "Specifies whether this workspace uses SAML 2.0, IAM Identity Center (successor to Single Sign-On), or both to authenticate users for using the Grafana console within a workspace. For more information, see <a href=\"https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html\">User authentication in Amazon Managed Grafana</a>."
        }
      ]
    },
    "samlConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamlConfiguration"
        },
        {
          "description": "If the workspace uses SAML, use this structure to map SAML assertion attributes to workspace user information and define which groups in the assertion attribute are to have the <code>Admin</code> and <code>Editor</code> roles in the workspace."
        }
      ]
    }
  },
  "required": [
    "authenticationProviders"
  ]
}