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.
{
"$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"
]
}
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.