Amazon Cognito · JSON Structure

Cognito Idp Update Identity Provider Request Structure

UpdateIdentityProviderRequest schema from Amazon Cognito

Type: object Properties: 5 Required: 2
AuthenticationAuthorizationIdentityIdentity ProviderOAuth2OIDC

UpdateIdentityProviderRequest is a JSON Structure definition published by Amazon Cognito, describing 5 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId ProviderName ProviderDetails AttributeMapping IdpIdentifiers

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID."
        }
      ]
    },
    "ProviderName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProviderNameType"
        },
        {
          "description": "The IdP name."
        }
      ]
    },
    "ProviderDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ProviderDetailsType"
        },
        {
          "description": "The IdP details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>."
        }
      ]
    },
    "AttributeMapping": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AttributeMappingType"
        },
        {
          "description": "The IdP attribute mapping to be changed."
        }
      ]
    },
    "IdpIdentifiers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdpIdentifiersListType"
        },
        {
          "description": "A list of IdP identifiers."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "ProviderName"
  ],
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-cognito/refs/heads/main/json-structure/cognito-idp-update-identity-provider-request-structure.json",
  "name": "UpdateIdentityProviderRequest",
  "description": "UpdateIdentityProviderRequest schema from Amazon Cognito"
}