UpdateSAMLProviderRequest

APIs.ioEngineeringPlatform

Properties

Name Type Description
SAMLMetadataDocument object
SAMLProviderArn object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-updatesamlproviderrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateSAMLProviderRequest",
  "title": "UpdateSAMLProviderRequest",
  "type": "object",
  "required": [
    "SAMLMetadataDocument",
    "SAMLProviderArn"
  ],
  "properties": {
    "SAMLMetadataDocument": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SAMLMetadataDocumentType"
        },
        {
          "description": "An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP."
        }
      ]
    },
    "SAMLProviderArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/arnType"
        },
        {
          "description": "<p>The Amazon Resource Name (ARN) of the SAML provider to update.</p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"
        }
      ]
    }
  }
}