Amazon OpenSearch Service API Opensearch Security Config API

The Opensearch Security Config API from Amazon OpenSearch Service API — 5 operation(s) for opensearch security config.

GitHub OpenAPI

Operations 5

POST /#CreateSecurityConfig Create Security Config #
POST /#GetSecurityConfig Get Security Config #
POST /#UpdateSecurityConfig Update Security Config #
POST /#DeleteSecurityConfig Delete Security Config #
POST /#ListSecurityConfigs List Security Configs #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-opensearch:amazon-opensearch-security-config-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-opensearch-security-config-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Security Config API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://aoss.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateSecurityConfig:
    post:
      operationId: CreateSecurityConfig
      summary: Create Security Config
      description: Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication
        for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateSecurityConfigResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.CreateSecurityConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateSecurityConfigRequest'
      tags:
      - Security Config
  /#GetSecurityConfig:
    post:
      operationId: GetSecurityConfig
      summary: Get Security Config
      description: Returns information about an OpenSearch Serverless security configuration. For more information, see SAML
        authentication for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetSecurityConfigResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.GetSecurityConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetSecurityConfigRequest'
      tags:
      - Security Config
  /#UpdateSecurityConfig:
    post:
      operationId: UpdateSecurityConfig
      summary: Update Security Config
      description: Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication
        for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateSecurityConfigResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.UpdateSecurityConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateSecurityConfigRequest'
      tags:
      - Security Config
  /#DeleteSecurityConfig:
    post:
      operationId: DeleteSecurityConfig
      summary: Delete Security Config
      description: Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication
        for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteSecurityConfigResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.DeleteSecurityConfig
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteSecurityConfigRequest'
      tags:
      - Security Config
  /#ListSecurityConfigs:
    post:
      operationId: ListSecurityConfigs
      summary: List Security Configs
      description: Returns information about configured OpenSearch Serverless security configurations. For more information,
        see SAML authentication for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListSecurityConfigsResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.ListSecurityConfigs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListSecurityConfigsRequest'
      tags:
      - Security Config
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: aoss
  schemas:
    AossConflictException:
      type: object
      properties:
        message:
          type: string
    AossResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    AossServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service Quotas requirement to identify originating service.
        quotaCode:
          type: string
          description: Service Quotas requirement to identify originating quota.
      required:
      - message
      - serviceCode
    AossValidationException:
      type: object
      properties:
        message:
          type: string
    CreateIamIdentityCenterConfigOptions:
      type: object
      properties:
        instanceArn:
          type: string
          description: The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
        userAttribute:
          type: string
          description: The user attribute for this IAM Identity Center integration. Defaults to UserId.
        groupAttribute:
          type: string
          description: The group attribute for this IAM Identity Center integration. Defaults to GroupId.
      required:
      - instanceArn
    CreateSecurityConfigRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of security configuration.
        name:
          type: string
          description: The name of the security configuration.
        description:
          type: string
          description: A description of the security configuration.
        samlOptions:
          $ref: '#/components/schemas/SamlConfigOptions'
        iamIdentityCenterOptions:
          $ref: '#/components/schemas/CreateIamIdentityCenterConfigOptions'
        iamFederationOptions:
          $ref: '#/components/schemas/IamFederationConfigOptions'
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - type
      - name
    CreateSecurityConfigResponse:
      type: object
      properties:
        securityConfigDetail:
          $ref: '#/components/schemas/SecurityConfigDetail'
    DeleteSecurityConfigRequest:
      type: object
      properties:
        id:
          type: string
          description: The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>.
            For example, saml/123456789123/OKTADev.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
    DeleteSecurityConfigResponse:
      type: object
      properties: {}
    GetSecurityConfigRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the security configuration.
      required:
      - id
    GetSecurityConfigResponse:
      type: object
      properties:
        securityConfigDetail:
          $ref: '#/components/schemas/SecurityConfigDetail'
    IamFederationConfigOptions:
      type: object
      properties:
        groupAttribute:
          type: string
          description: The group attribute for this IAM federation integration. This attribute is used to map identity provider
            groups to OpenSearch Serverless permissions.
        userAttribute:
          type: string
          description: The user attribute for this IAM federation integration. This attribute is used to identify users in
            the federated authentication process.
    IamIdentityCenterConfigOptions:
      type: object
      properties:
        instanceArn:
          type: string
          description: The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
        applicationArn:
          type: string
          description: The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
        applicationName:
          type: string
          description: The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
        applicationDescription:
          type: string
          description: The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
        userAttribute:
          type: string
          description: The user attribute for this IAM Identity Center integration. Defaults to UserId
        groupAttribute:
          type: string
          description: The group attribute for this IAM Identity Center integration. Defaults to GroupId.
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListSecurityConfigsRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of security configuration.
        nextToken:
          type: string
          description: If your initial ListSecurityConfigs operation returns a nextToken, you can include the returned nextToken
            in subsequent ListSecurityConfigs operations, which returns results in the next page.
        maxResults:
          type: integer
          description: An optional parameter that specifies the maximum number of results to return. You can use nextToken
            to get the next page of results. The default is 20.
      required:
      - type
    ListSecurityConfigsResponse:
      type: object
      properties:
        securityConfigSummaries:
          type: array
          items:
            $ref: '#/components/schemas/SecurityConfigSummary'
          description: Details about the security configurations in your account.
        nextToken:
          type: string
          description: When nextToken is returned, there are more results available. The value of nextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page.
    SamlConfigOptions:
      type: object
      properties:
        metadata:
          type: string
          description: The XML IdP metadata file generated from your identity provider.
        userAttribute:
          type: string
          description: A user attribute for this SAML integration.
        groupAttribute:
          type: string
          description: The group attribute for this SAML integration.
        openSearchServerlessEntityId:
          type: string
          description: Custom entity ID attribute to override the default entity ID for this SAML integration.
        sessionTimeout:
          type: integer
          description: The session timeout, in minutes. Default is 60 minutes (12 hours).
      required:
      - metadata
    SecurityConfigDetail:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the security configuration.
        type:
          type: string
          description: The type of security configuration.
        configVersion:
          type: string
          description: The version of the security configuration.
        description:
          type: string
          description: The description of the security configuration.
        samlOptions:
          $ref: '#/components/schemas/SamlConfigOptions'
        iamIdentityCenterOptions:
          $ref: '#/components/schemas/IamIdentityCenterConfigOptions'
        iamFederationOptions:
          $ref: '#/components/schemas/IamFederationConfigOptions'
        createdDate:
          type: integer
          description: The date the configuration was created.
        lastModifiedDate:
          type: integer
          description: The timestamp of when the configuration was last modified.
    SecurityConfigSummary:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the security configuration.
        type:
          type: string
          description: The type of security configuration.
        configVersion:
          type: string
          description: The version of the security configuration.
        description:
          type: string
          description: The description of the security configuration.
        createdDate:
          type: integer
          description: The Epoch time when the security configuration was created.
        lastModifiedDate:
          type: integer
          description: The timestamp of when the configuration was last modified.
    UpdateIamIdentityCenterConfigOptions:
      type: object
      properties:
        userAttribute:
          type: string
          description: The user attribute for this IAM Identity Center integration. Defaults to UserId.
        groupAttribute:
          type: string
          description: The group attribute for this IAM Identity Center integration. Defaults to GroupId.
    UpdateSecurityConfigRequest:
      type: object
      properties:
        id:
          type: string
          description: The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>.
            For example, saml/123456789123/OKTADev.
        configVersion:
          type: string
          description: The version of the security configuration to be updated. You can find the most recent version of a
            security configuration using the GetSecurityPolicy command.
        description:
          type: string
          description: A description of the security configuration.
        samlOptions:
          $ref: '#/components/schemas/SamlConfigOptions'
        iamIdentityCenterOptionsUpdates:
          $ref: '#/components/schemas/UpdateIamIdentityCenterConfigOptions'
        iamFederationOptions:
          $ref: '#/components/schemas/IamFederationConfigOptions'
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - id
      - configVersion
    UpdateSecurityConfigResponse:
      type: object
      properties:
        securityConfigDetail:
          $ref: '#/components/schemas/SecurityConfigDetail'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)