# Keycloak Role Mapper API

**Canonical:** https://apis.io/apis/keycloak/keycloak-role-mapper-api/  
**Provider:** Keycloak — https://apis.io/providers/keycloak/  
**Documentation:** https://www.keycloak.org/docs-api/latest/rest-api/

Keycloak Role Mapper API is one of 23 APIs that [Keycloak](https://apis.io/providers/keycloak/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Role Mapper. The published artifact set on APIs.io includes an OpenAPI specification.

The Role Mapper API from Keycloak — 12 operation(s) for role mapper.

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/realms/{realm}/groups/{group-id}/role-mappings` | Get role mappings |
| GET | `/admin/realms/{realm}/groups/{group-id}/role-mappings/realm` | Get realm-level role mappings |
| POST | `/admin/realms/{realm}/groups/{group-id}/role-mappings/realm` | Add realm-level role mappings to the user |
| DELETE | `/admin/realms/{realm}/groups/{group-id}/role-mappings/realm` | Delete realm-level role mappings |
| GET | `/admin/realms/{realm}/groups/{group-id}/role-mappings/realm/available` | Get realm-level roles that can be mapped |
| GET | `/admin/realms/{realm}/groups/{group-id}/role-mappings/realm/composite` | Get effective realm-level role mappings This will recurse all composite roles… |
| GET | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings` | Get role mappings |
| GET | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm` | Get realm-level role mappings |
| POST | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm` | Add realm-level role mappings to the user |
| DELETE | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm` | Delete realm-level role mappings |
| GET | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm/available` | Get realm-level roles that can be mapped |
| GET | `/admin/realms/{realm}/organizations/{org-id}/groups/{group-id}/role-mappings/realm/composite` | Get effective realm-level role mappings This will recurse all composite roles… |
| GET | `/admin/realms/{realm}/users/{user-id}/role-mappings` | Get role mappings |
| GET | `/admin/realms/{realm}/users/{user-id}/role-mappings/realm` | Get realm-level role mappings |
| POST | `/admin/realms/{realm}/users/{user-id}/role-mappings/realm` | Add realm-level role mappings to the user |
| DELETE | `/admin/realms/{realm}/users/{user-id}/role-mappings/realm` | Delete realm-level role mappings |
| GET | `/admin/realms/{realm}/users/{user-id}/role-mappings/realm/available` | Get realm-level roles that can be mapped |
| GET | `/admin/realms/{realm}/users/{user-id}/role-mappings/realm/composite` | Get effective realm-level role mappings This will recurse all composite roles… |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/keycloak/openapi/keycloak-role-mapper-api-openapi.yml

## Other Keycloak APIs (12)

- [Keycloak Clients API](https://apis.io/apis/keycloak/keycloak-clients-api/)
- [Keycloak Groups API](https://apis.io/apis/keycloak/keycloak-groups-api/)
- [Keycloak Identity Providers API](https://apis.io/apis/keycloak/keycloak-identity-providers-api/)
- [Keycloak Realms API](https://apis.io/apis/keycloak/keycloak-realms-api/)
- [Keycloak Roles API](https://apis.io/apis/keycloak/keycloak-roles-api/)
- [Keycloak Users API](https://apis.io/apis/keycloak/keycloak-users-api/)
- [Keycloak Admin API](https://apis.io/apis/keycloak/keycloak-admin-api/)
- [Keycloak Attack Detection API](https://apis.io/apis/keycloak/keycloak-attack-detection-api/)
- [Keycloak Authentication Management API](https://apis.io/apis/keycloak/keycloak-authentication-management-api/)
- [Keycloak Client Attribute Certificate API](https://apis.io/apis/keycloak/keycloak-client-attribute-certificate-api/)
- [Keycloak Client Initial Access API](https://apis.io/apis/keycloak/keycloak-client-initial-access-api/)
- [Keycloak Client Registration Policy API](https://apis.io/apis/keycloak/keycloak-client-registration-policy-api/)

## Tags

Role Mapper

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/keycloak/keycloak-role-mapper-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/keycloak/.