Amazon Cognito · JSON Structure

Identity Pools Get Identity Pool Roles Response Structure

Returned in response to a successful GetIdentityPoolRoles operation.

Type: object Properties: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

IdentityPoolId Roles RoleMappings

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-get-identity-pool-roles-response-structure.json",
  "name": "GetIdentityPoolRolesResponse",
  "description": "Returned in response to a successful <code>GetIdentityPoolRoles</code> operation.",
  "type": "object",
  "properties": {
    "IdentityPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityPoolId"
        },
        {
          "description": "An identity pool ID in the format REGION:GUID."
        }
      ]
    },
    "Roles": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RolesMap"
        },
        {
          "description": "The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported."
        }
      ]
    },
    "RoleMappings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleMappingMap"
        },
        {
          "description": "How users for a specific identity provider are to mapped to roles. This is a String-to-<a>RoleMapping</a> object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\"."
        }
      ]
    }
  }
}