Amazon OpenSearch Service API · JSON Structure

Openapi Saml Options Input Structure

Specifies the SAML application configuration for the domain.

Type: object Properties: 7
AnalyticsElasticsearchSearch

SAMLOptionsInput is a JSON Structure definition published by Amazon OpenSearch Service API, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Enabled Idp MasterUserName MasterBackendRole SubjectKey RolesKey SessionTimeoutMinutes

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-opensearch/refs/heads/main/json-structure/openapi-saml-options-input-structure.json",
  "name": "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."
        }
      ]
    }
  }
}