## Uses of Interface
org.keycloak.models.RoleModel

- Packages that use RoleModel
  Package | Description
  --- | ---
  org.keycloak.login |
  org.keycloak.login.freemarker |
  org.keycloak.login.freemarker.model |
  org.keycloak.models |
  org.keycloak.models.jpa |
  org.keycloak.models.mongo.keycloak.adapters |
  org.keycloak.models.utils |
  org.keycloak.services.managers |
  org.keycloak.services.resources.admin |

- - ### Uses of RoleModel in org.keycloak.login

    Method parameters in org.keycloak.login with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `LoginFormsProvider` | LoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.login.freemarker

    Method parameters in org.keycloak.login.freemarker with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `LoginFormsProvider` | FreeMarkerLoginFormsProvider.`setAccessRequest(List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.login.freemarker.model

    Methods in org.keycloak.login.freemarker.model that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `List<RoleModel>` | OAuthGrantBean.`getRealmRolesRequested()`
    `javax.ws.rs.core.MultivaluedMap<String,RoleModel>` | OAuthGrantBean.`getResourceRolesRequested()`

    Constructor parameters in org.keycloak.login.freemarker.model with type arguments of type RoleModel
    Constructor and Description
    `OAuthGrantBean(String code, ClientModel client, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `OAuthGrantBean(String code, ClientModel client, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.models

    Methods in org.keycloak.models that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RoleContainerModel.`addRole(String name)`
    `RoleModel` | RoleContainerModel.`addRole(String id, String name)`
    `RoleModel` | RoleContainerModel.`getRole(String name)`
    `RoleModel` | RealmModel.`getRoleById(String id)`

    Methods in org.keycloak.models that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | ApplicationModel.`getApplicationRoleMappings(UserModel user)`
    `Set<RoleModel>` | ApplicationModel.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleModel.`getComposites()`
    `Set<RoleModel>` | RealmModel.`getRealmRoleMappings(UserModel user)`
    `Set<RoleModel>` | RealmModel.`getRealmScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleMapperModel.`getRoleMappings(UserModel user)`
    `Set<RoleModel>` | RoleContainerModel.`getRoles()`
    `Set<RoleModel>` | ScopeMapperModel.`getScopeMappings(ClientModel client)`

    Methods in org.keycloak.models with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleModel.`addCompositeRole(RoleModel role)`
    `void` | ScopeMapperModel.`addScopeMapping(ClientModel client, RoleModel role)`
    `void` | RoleMapperModel.`deleteRoleMapping(UserModel user, RoleModel role)`
    `void` | ScopeMapperModel.`deleteScopeMapping(ClientModel client, RoleModel role)`
    `void` | RoleMapperModel.`grantRole(UserModel user, RoleModel role)`
    `boolean` | RoleModel.`hasRole(RoleModel role)`
    `boolean` | RoleMapperModel.`hasRole(UserModel user, RoleModel role)`
    `boolean` | RealmModel.`hasScope(ClientModel client, RoleModel role)`
    `void` | RoleModel.`removeCompositeRole(RoleModel role)`
    `boolean` | RoleContainerModel.`removeRole(RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.models.jpa

    Classes in org.keycloak.models.jpa that implement RoleModel
    Modifier and Type | Class and Description
    --- | ---
    `class` | `RoleAdapter`

    Methods in org.keycloak.models.jpa that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RealmAdapter.`addRole(String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String name)`
    `RoleModel` | RealmAdapter.`addRole(String id, String name)`
    `RoleModel` | ApplicationAdapter.`addRole(String id, String name)`
    `RoleModel` | RealmAdapter.`getRole(String name)`
    `RoleModel` | ApplicationAdapter.`getRole(String name)`
    `RoleModel` | RealmAdapter.`getRoleById(String id)`

    Methods in org.keycloak.models.jpa that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationRoleMappings(UserModel user)`
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleAdapter.`getComposites()`
    `Set<RoleModel>` | RealmAdapter.`getRealmRoleMappings(UserModel user)`
    `Set<RoleModel>` | RealmAdapter.`getRealmScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RealmAdapter.`getRoleMappings(UserModel user)`
    `Set<RoleModel>` | RealmAdapter.`getRoles()`
    `Set<RoleModel>` | ApplicationAdapter.`getRoles()`
    `Set<RoleModel>` | RealmAdapter.`getScopeMappings(ClientModel client)`

    Methods in org.keycloak.models.jpa with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleAdapter.`addCompositeRole(RoleModel role)`
    `void` | RealmAdapter.`addScopeMapping(ClientModel client, RoleModel role)`
    `void` | RealmAdapter.`deleteRoleMapping(UserModel user, RoleModel role)`
    `void` | RealmAdapter.`deleteScopeMapping(ClientModel client, RoleModel role)`
    `void` | RealmAdapter.`grantRole(UserModel user, RoleModel role)`
    `boolean` | RoleAdapter.`hasRole(RoleModel role)`
    `boolean` | RealmAdapter.`hasRole(UserModel user, RoleModel role)`
    `boolean` | RealmAdapter.`hasScope(ClientModel client, RoleModel role)`
    `void` | RoleAdapter.`removeCompositeRole(RoleModel role)`
    `boolean` | RealmAdapter.`removeRole(RoleModel role)`
    `boolean` | ApplicationAdapter.`removeRole(RoleModel roleModel)`

  - ### Uses of RoleModel in org.keycloak.models.mongo.keycloak.adapters

    Methods in org.keycloak.models.mongo.keycloak.adapters that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `RoleModel` | RealmAdapter.`addRole(String name)`
    `RoleModel` | RealmAdapter.`addRole(String id, String name)`
    `RoleModel` | RealmAdapter.`getRoleById(String id)`

    Methods in org.keycloak.models.mongo.keycloak.adapters that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationRoleMappings(UserModel user)`
    `Set<RoleModel>` | ApplicationAdapter.`getApplicationScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RoleAdapter.`getComposites()`
    `Set<RoleModel>` | RealmAdapter.`getRealmRoleMappings(UserModel user)`
    `Set<RoleModel>` | RealmAdapter.`getRealmScopeMappings(ClientModel client)`
    `Set<RoleModel>` | RealmAdapter.`getRoleMappings(UserModel user)`
    `Set<RoleModel>` | RealmAdapter.`getRoles()`
    `Set<RoleModel>` | ApplicationAdapter.`getRoles()`
    `Set<RoleModel>` | RealmAdapter.`getScopeMappings(ClientModel client)`

    Methods in org.keycloak.models.mongo.keycloak.adapters with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleAdapter.`addCompositeRole(RoleModel childRole)`
    `void` | RealmAdapter.`addScopeMapping(ClientModel client, RoleModel role)`
    `void` | RealmAdapter.`deleteRoleMapping(UserModel user, RoleModel role)`
    `void` | RealmAdapter.`deleteScopeMapping(ClientModel client, RoleModel role)`
    `void` | RealmAdapter.`grantRole(UserModel user, RoleModel role)`
    `boolean` | RoleAdapter.`hasRole(RoleModel role)`
    `boolean` | RealmAdapter.`hasRole(UserModel user, RoleModel role)`
    `boolean` | RealmAdapter.`hasScope(ClientModel client, RoleModel role)`
    `void` | RoleAdapter.`removeCompositeRole(RoleModel childRole)`
    `boolean` | RealmAdapter.`removeRole(RoleModel role)`
    `boolean` | ApplicationAdapter.`removeRole(RoleModel role)`

  - ### Uses of RoleModel in org.keycloak.models.utils

    Methods in org.keycloak.models.utils with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | KeycloakModelUtils.`searchFor(RoleModel role, RoleModel composite, Set<RoleModel> visited)` Deep search if given role is descendant of composite role

    Method parameters in org.keycloak.models.utils with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static boolean` | KeycloakModelUtils.`searchFor(RoleModel role, RoleModel composite, Set<RoleModel> visited)` Deep search if given role is descendant of composite role

  - ### Uses of RoleModel in org.keycloak.services.managers

    Fields in org.keycloak.services.managers with type parameters of type RoleModel
    Modifier and Type | Field and Description
    --- | ---
    `protected List<RoleModel>` | AccessCodeEntry.`realmRolesRequested`

    Methods in org.keycloak.services.managers that return types with arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `List<RoleModel>` | AccessCodeEntry.`getRealmRolesRequested()`
    `javax.ws.rs.core.MultivaluedMap<String,RoleModel>` | AccessCodeEntry.`getResourceRolesRequested()`

    Methods in org.keycloak.services.managers with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | TokenManager.`addComposites(AccessToken token, RoleModel role)`
    `void` | RealmManager.`addComposites(RoleModel role, RoleRepresentation roleRep, RealmModel realm)`
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`
    `static RoleRepresentation` | ModelToRepresentation.`toRepresentation(RoleModel role)`

    Method parameters in org.keycloak.services.managers with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`
    `static void` | TokenManager.`applyScope(RoleModel role, RoleModel scope, Set<RoleModel> visited, Set<RoleModel> requested)`
    `AccessToken` | TokenManager.`createClientAccessToken(String scopeParam, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`
    `AccessToken` | TokenManager.`createClientAccessToken(String scopeParam, RealmModel realm, ClientModel client, UserModel user, UserSessionModel session, List<RoleModel> realmRolesRequested, javax.ws.rs.core.MultivaluedMap<String,RoleModel> resourceRolesRequested)`

  - ### Uses of RoleModel in org.keycloak.services.resources.admin

    Methods in org.keycloak.services.resources.admin that return RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected RoleModel` | RoleByIdResource.`getRoleModel(String id)`

    Methods in org.keycloak.services.resources.admin with parameters of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | RoleResource.`addComposites(List<RoleRepresentation> roles, RoleModel role)`
    `protected void` | RoleResource.`deleteComposites(List<RoleRepresentation> roles, RoleModel role)`
    `protected void` | RoleResource.`deleteRole(RoleModel role)`
    `protected Set<RoleRepresentation>` | RoleResource.`getApplicationRoleComposites(String appName, RoleModel role)`
    `protected Set<RoleRepresentation>` | RoleResource.`getRealmRoleComposites(RoleModel role)`
    `protected RoleRepresentation` | RoleResource.`getRole(RoleModel roleModel)`
    `protected Set<RoleRepresentation>` | RoleResource.`getRoleComposites(RoleModel role)`
    `protected void` | RoleResource.`updateRole(RoleRepresentation rep, RoleModel role)`

    Method parameters in org.keycloak.services.resources.admin with type arguments of type RoleModel
    Modifier and Type | Method and Description
    --- | ---
    `protected List<RoleRepresentation>` | UsersResource.`getAvailableRoles(UserModel user, Set<RoleModel> available)`

Copyright © 2014. All Rights Reserved.