SAMLOptionsInput

Specifies the SAML application configuration for the domain.

AnalyticsElasticsearchSearch

Properties

Name Type Description
Enabled object
Idp object
MasterUserName object
MasterBackendRole object
SubjectKey object
RolesKey object
SessionTimeoutMinutes object
View JSON Schema on GitHub

JSON Schema

openapi-saml-options-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-saml-options-input-schema.json",
  "title": "SAMLOptionsInput",
  "description": "Specifies the SAML application configuration for the domain.",
  "type": "object",
  "properties": {
    "Enabled": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "True if SAML is enabled."
        }
      ]
    },
    "Idp": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SAMLIdp"
        },
        {
          "description": "Specifies the SAML Identity Provider's information."
        }
      ]
    },
    "MasterUserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Username"
        },
        {
          "description": "The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database."
        }
      ]
    },
    "MasterBackendRole": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BackendRole"
        },
        {
          "description": "The backend role to which the SAML master user is mapped to."
        }
      ]
    },
    "SubjectKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The key to use for matching the SAML Subject attribute."
        }
      ]
    },
    "RolesKey": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The key to use for matching the SAML Roles attribute."
        }
      ]
    },
    "SessionTimeoutMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IntegerClass"
        },
        {
          "description": "The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60."
        }
      ]
    }
  }
}