---
updatedAt: 2026-07-28T19:33:42.000Z
---

# (Beta) Get the assigned claims

Get the claim to user group mappings (or claim mappings).<br><br><a href="https://api.solace.dev/cloud/reference/authentication">Token Permissions</a>: [ <code>iam_claim_mapping:read</code> ]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Platform",
    "description": "# REST API Concepts\n\nSolace PubSub+ Platform provides RESTful APIs that you can use to manage your data in PubSub+ Cloud. The REST APIs allow\nyou to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use. Please note that these APIs are in the Early\nAccess release stage and are available for testing and early user feedback. The APIs are subject to change until they\nare declared Generally Available.",
    "version": "2.2.2"
  },
  "servers": [
    {
      "url": "https://api.solace.cloud",
      "description": "Solace PubSub+ Cloud US EAST Region"
    },
    {
      "url": "https://api.solacecloud.com.au",
      "description": "Solace PubSub+ Cloud AU Region"
    },
    {
      "url": "https://api.solacecloud.eu",
      "description": "Solace PubSub+ Cloud EU Region"
    },
    {
      "url": "https://api.solacecloud.sg",
      "description": "Solace PubSub+ Cloud SG Region"
    }
  ],
  "security": [
    {
      "APIToken": []
    }
  ],
  "tags": [
    {
      "name": "Single Sign-On"
    }
  ],
  "paths": {
    "/api/v2/platform/sso/idpClaimMappings": {
      "get": {
        "tags": [
          "Single Sign-On"
        ],
        "summary": "(Beta) Get the assigned claims",
        "description": "Get the claim to user group mappings (or claim mappings).<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>iam_claim_mapping:read</code> ]",
        "operationId": "getClaimMappings",
        "responses": {
          "200": {
            "description": "OK.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ClaimMappingResponseEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Bad request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "Bad request.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              },
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized."
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "You do not have permissions to perform this operation.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "Could not find service 4o5kyf4x5504.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "502": {
            "description": "Bad Gateway - Marketplace integration error.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ClaimMappingResponse": {
        "type": "object",
        "default": null,
        "properties": {
          "claimKey": {
            "type": "string",
            "default": "",
            "description": "The claim key or name of the token issued by the identity provider (IdP).",
            "example": "claim"
          },
          "claimValueToGroupsMapping": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            },
            "default": "",
            "description": "The claim mapping. A claim mapping is the value from the claim to the unique identifiers of the user groups.",
            "example": {
              "administrator": [
                "5ab4b2f6-0e2f-48d5-bded-5f0b934731f0"
              ],
              "viewer": [
                "f153287f-a8a5-4465-b783-b38da6c2866c",
                "b2168cb3-0a32-475a-9ace-014f67205891"
              ]
            }
          },
          "justInTimeProvisioning": {
            "type": "boolean",
            "default": false,
            "description": "Indicates whether to allow Just-In-Time (JIT). The valid values are 'true' (enable) or 'false' (disable). The default is 'false'."
          },
          "defaultGroupId": {
            "type": "string",
            "format": "uuid",
            "default": "",
            "description": "The unique identifier of the user group to assign to a user when user's claim doesn't match any of the claims in the account (organization).",
            "example": "b2168cb3-0a32-475a-9ace-014f67205891"
          },
          "state": {
            "type": "string",
            "default": "",
            "description": "The state of the claim mapping. The following states are:<ul><li>`enabled`- Use the claim mapping. Users that log in using SSO are mapped to specified roles.</li><li>`disabled`- To not use the claim mapping. Users that log in using SSO are not mapped to the specified roles.</li></ul>",
            "enum": [
              "enabled",
              "disabled"
            ]
          }
        }
      },
      "ClaimMappingResponseEnvelope": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/ClaimMappingResponse"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {},
            "default": "",
            "description": "<p>The metadata about the response, which can include:</p><ul><li>Pagination data, such as page number, page size, etc. for GET operations that return large amount of response data. For more information, see <a href=\"./pagination\">Pagination</a>.</li><li>Timestamp information, such as current time, or the time create or update operation occurred for CREATE, PUT, POST operations.</li></ul>"
          },
          "included": {
            "type": "array",
            "items": {}
          }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "default": null,
        "properties": {
          "message": {
            "type": "string",
            "default": "",
            "description": "A user-friendly message that describes the error.",
            "example": "An error occurred."
          },
          "errorId": {
            "type": "string",
            "default": "",
            "description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
            "example": "123e4567-e89b-12d3-a456-426655440000"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {},
            "default": "",
            "description": "The metadata about the error. This provides additional information about the error that occurred.",
            "example": "'object': { 'field': 'description' }"
          },
          "validationDetails": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "default": "",
            "description": "When applicable, these are the details of issues with the fields provided for the REST call.",
            "example": "'name': ['Not unique']"
          }
        }
      }
    },
    "securitySchemes": {
      "APIToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```