MappingRule is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/identity-pools-mapping-rule-structure.json",
"name": "MappingRule",
"description": "A rule that maps a claim name, a claim value, and a match type to a role ARN.",
"type": "object",
"properties": {
"Claim": {
"allOf": [
{
"$ref": "#/components/schemas/ClaimName"
},
{
"description": "The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\"."
}
]
},
"MatchType": {
"allOf": [
{
"$ref": "#/components/schemas/MappingRuleMatchType"
},
{
"description": "The match condition that specifies how closely the claim value in the IdP token must match <code>Value</code>."
}
]
},
"Value": {
"allOf": [
{
"$ref": "#/components/schemas/ClaimValue"
},
{
"description": "A brief string that the claim must match, for example, \"paid\" or \"yes\"."
}
]
},
"RoleARN": {
"allOf": [
{
"$ref": "#/components/schemas/ARNString"
},
{
"description": "The role ARN."
}
]
}
},
"required": [
"Claim",
"MatchType",
"Value",
"RoleARN"
]
}
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.