Amazon Cognito · JSON Structure

Identity Pools Role Mapping Structure

A role mapping.

Type: object Properties: 3 Required: 1
AuthenticationIdentityOIDCSAMLUser ManagementFederated Identity

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

Properties

Type AmbiguousRoleResolution RulesConfiguration

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-cognito/refs/heads/main/json-structure/identity-pools-role-mapping-structure.json",
  "name": "RoleMapping",
  "description": "A role mapping.",
  "type": "object",
  "properties": {
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleMappingType"
        },
        {
          "description": "The role mapping type. Token will use <code>cognito:roles</code> and <code>cognito:preferred_role</code> claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role."
        }
      ]
    },
    "AmbiguousRoleResolution": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AmbiguousRoleResolutionType"
        },
        {
          "description": "<p>If you specify Token or Rules as the <code>Type</code>, <code>AmbiguousRoleResolution</code> is required.</p> <p>Specifies the action to be taken if either no rules match the claim value for the <code>Rules</code> type, or there is no <code>cognito:preferred_role</code> claim and there are multiple <code>cognito:roles</code> matches for the <code>Token</code> type.</p>"
        }
      ]
    },
    "RulesConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RulesConfigurationType"
        },
        {
          "description": "<p>The rules to be used for mapping users to roles.</p> <p>If you specify Rules as the role mapping type, <code>RulesConfiguration</code> is required.</p>"
        }
      ]
    }
  },
  "required": [
    "Type"
  ]
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • 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 JSON Structure
curl "https://apis.io/api/v1/json-structures/identity-pools-role-mapping-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.