# Keycloak Scope Mappings API

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

Keycloak Scope Mappings 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 Scope Mappings. The published artifact set on APIs.io includes an OpenAPI specification.

The Scope Mappings API from Keycloak — 21 operation(s) for scope mappings.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings` | Get all scope mappings for the client |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}` | Get the roles associated with a client's scope Returns roles for the client |
| POST | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}` | Add client-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}` | Remove client-level roles from the client's scope |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/available` | The available client-level roles Returns the roles for the client that can be… |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/clients/{client}/composite` | Get effective client roles Returns the roles for the client that are associated… |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm` | Get realm-level roles associated with the client's scope |
| POST | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm` | Add a set of realm-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm` | Remove a set of realm-level roles from the client's scope |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/available` | Get realm-level roles that are available to attach to this client's scope |
| GET | `/admin/realms/{realm}/client-scopes/{client-scope-id}/scope-mappings/realm/composite` | Get effective realm-level roles associated with the client’s scope What this… |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings` | Get all scope mappings for the client |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}` | Get the roles associated with a client's scope Returns roles for the client |
| POST | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}` | Add client-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}` | Remove client-level roles from the client's scope |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/available` | The available client-level roles Returns the roles for the client that can be… |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/clients/{client}/composite` | Get effective client roles Returns the roles for the client that are associated… |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm` | Get realm-level roles associated with the client's scope |
| POST | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm` | Add a set of realm-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm` | Remove a set of realm-level roles from the client's scope |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/available` | Get realm-level roles that are available to attach to this client's scope |
| GET | `/admin/realms/{realm}/client-templates/{client-scope-id}/scope-mappings/realm/composite` | Get effective realm-level roles associated with the client’s scope What this… |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings` | Get all scope mappings for the client |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}` | Get the roles associated with a client's scope Returns roles for the client |
| POST | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}` | Add client-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}` | Remove client-level roles from the client's scope |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/available` | The available client-level roles Returns the roles for the client that can be… |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/clients/{client}/composite` | Get effective client roles Returns the roles for the client that are associated… |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm` | Get realm-level roles associated with the client's scope |
| POST | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm` | Add a set of realm-level roles to the client's scope |
| DELETE | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm` | Remove a set of realm-level roles from the client's scope |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/available` | Get realm-level roles that are available to attach to this client's scope |
| GET | `/admin/realms/{realm}/clients/{client-uuid}/scope-mappings/realm/composite` | Get effective realm-level roles associated with the client’s scope What this… |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/keycloak/openapi/keycloak-scope-mappings-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

Scope Mappings

---

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