## Uses of Class
org.keycloak.representations.idm.RoleRepresentation

- Packages that use RoleRepresentation
  Package | Description
  --- | ---
  org.keycloak.admin.client.resource |
  org.keycloak.example |
  org.keycloak.exportimport.util |
  org.keycloak.models.utils |
  org.keycloak.representations.idm |
  org.keycloak.services.resources.admin |

- - ### Uses of RoleRepresentation in org.keycloak.admin.client.resource

    Methods in org.keycloak.admin.client.resource that return RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `RoleRepresentation` | RoleResource.`toRepresentation()`

    Methods in org.keycloak.admin.client.resource that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `Set<RoleRepresentation>` | RoleResource.`getApplicationLevelChildren(String appName)`
    `Set<RoleRepresentation>` | RoleResource.`getChildren()`
    `Set<RoleRepresentation>` | RoleResource.`getRealmLevelChildren()`
    `List<RoleRepresentation>` | RolesResource.`list()`
    `List<RoleRepresentation>` | RoleScopeResource.`listAll()`
    `List<RoleRepresentation>` | RoleScopeResource.`listAvailable()`
    `List<RoleRepresentation>` | RoleScopeResource.`listEffective()`

    Methods in org.keycloak.admin.client.resource with parameters of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | RolesResource.`create(RoleRepresentation roleRepresentation)`
    `void` | RoleResource.`update(RoleRepresentation roleRepresentation)`

    Method parameters in org.keycloak.admin.client.resource with type arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | RoleScopeResource.`add(List<RoleRepresentation> rolesToAdd)`
    `void` | RoleResource.`addChildren(List<RoleRepresentation> rolesToAdd)`
    `void` | RoleScopeResource.`remove(List<RoleRepresentation> rolesToRemove)`
    `void` | RoleResource.`removeChildren(List<RoleRepresentation> rolesToRemove)`

  - ### Uses of RoleRepresentation in org.keycloak.example

    Methods in org.keycloak.example that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static List<RoleRepresentation>` | AdminClient.`getRealmRoles(javax.servlet.http.HttpServletRequest req)`

  - ### Uses of RoleRepresentation in org.keycloak.exportimport.util

    Methods in org.keycloak.exportimport.util that return RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static RoleRepresentation` | ExportUtils.`exportRole(RoleModel role)` Full export of role including composite roles

    Methods in org.keycloak.exportimport.util that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static List<RoleRepresentation>` | ExportUtils.`exportRoles(Collection<RoleModel> roles)`

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

    Methods in org.keycloak.models.utils that return RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static RoleRepresentation` | ModelToRepresentation.`toRepresentation(RoleModel role)`

    Methods in org.keycloak.models.utils with parameters of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static void` | RepresentationToModel.`createRole(RealmModel newRealm, RoleRepresentation roleRep)`

  - ### Uses of RoleRepresentation in org.keycloak.representations.idm

    Fields in org.keycloak.representations.idm with type parameters of type RoleRepresentation
    Modifier and Type | Field and Description
    --- | ---
    `protected Map<String,List<RoleRepresentation>>` | RolesRepresentation.`application`
    `protected List<RoleRepresentation>` | ApplicationMappingsRepresentation.`mappings`
    `protected List<RoleRepresentation>` | RolesRepresentation.`realm`
    `protected List<RoleRepresentation>` | MappingsRepresentation.`realmMappings`

    Methods in org.keycloak.representations.idm that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `Map<String,List<RoleRepresentation>>` | RolesRepresentation.`getApplication()`
    `List<RoleRepresentation>` | ApplicationMappingsRepresentation.`getMappings()`
    `List<RoleRepresentation>` | RolesRepresentation.`getRealm()`
    `List<RoleRepresentation>` | MappingsRepresentation.`getRealmMappings()`

    Method parameters in org.keycloak.representations.idm with type arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | RolesRepresentation.`setApplication(Map<String,List<RoleRepresentation>> application)`
    `void` | ApplicationMappingsRepresentation.`setMappings(List<RoleRepresentation> mappings)`
    `void` | RolesRepresentation.`setRealm(List<RoleRepresentation> realm)`
    `void` | MappingsRepresentation.`setRealmMappings(List<RoleRepresentation> realmMappings)`

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

    Methods in org.keycloak.services.resources.admin that return RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `protected RoleRepresentation` | RoleResource.`getRole(RoleModel roleModel)`
    `RoleRepresentation` | RoleByIdResource.`getRole(String id)` Get a specific role's representation
    `RoleRepresentation` | RoleContainerResource.`getRole(String roleName)` Get a role by name

    Methods in org.keycloak.services.resources.admin that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `protected Set<RoleRepresentation>` | RoleResource.`getApplicationRoleComposites(String appName, RoleModel role)`
    `Set<RoleRepresentation>` | RoleByIdResource.`getApplicationRoleComposites(String id, String appName)` Return a set of application-level roles for a specific app that are in the role's composite
    `Set<RoleRepresentation>` | RoleContainerResource.`getApplicationRoleComposites(String roleName, String appName)` An app-level roles for a specific app for this role's composite
    `List<RoleRepresentation>` | UsersResource.`getApplicationRoleMappings(String username, String appName)` Get application-level role mappings for this user for a specific app
    `List<RoleRepresentation>` | ScopeMappedResource.`getApplicationScopeMappings(String appName)` Get the roles associated with a client's scope for a specific application.
    `List<RoleRepresentation>` | UsersResource.`getAvailableApplicationRoleMappings(String username, String appName)` Get available application-level roles that can be mapped to the user
    `List<RoleRepresentation>` | ScopeMappedResource.`getAvailableApplicationScopeMappings(String appName)` The available application-level roles that can be associated with the client's scope
    `List<RoleRepresentation>` | UsersResource.`getAvailableRealmRoleMappings(String username)` Realm-level roles that can be mapped to this user
    `List<RoleRepresentation>` | ScopeMappedResource.`getAvailableRealmScopeMappings()` Get list of realm-level roles that are available to attach to this client's scope.
    `protected List<RoleRepresentation>` | UsersResource.`getAvailableRoles(UserModel user, Set<RoleModel> available)`
    `List<RoleRepresentation>` | UsersResource.`getCompositeApplicationRoleMappings(String username, String appName)` Get effective application-level role mappings.
    `List<RoleRepresentation>` | ScopeMappedResource.`getCompositeApplicationScopeMappings(String appName)` Get effective application roles that are associated with the client's scope for a specific application.
    `List<RoleRepresentation>` | UsersResource.`getCompositeRealmRoleMappings(String username)` Effective realm-level role mappings for this user.
    `List<RoleRepresentation>` | ScopeMappedResource.`getCompositeRealmScopeMappings()` Get all effective realm-level roles that are associated with this client's scope.
    `protected Set<RoleRepresentation>` | RoleResource.`getRealmRoleComposites(RoleModel role)`
    `Set<RoleRepresentation>` | RoleByIdResource.`getRealmRoleComposites(String id)` Return a set of realm-level roles that are in the role's composite
    `Set<RoleRepresentation>` | RoleContainerResource.`getRealmRoleComposites(String roleName)` Get realm-level roles of this role's composite
    `List<RoleRepresentation>` | UsersResource.`getRealmRoleMappings(String username)` Get realm-level role mappings for this user
    `List<RoleRepresentation>` | ScopeMappedResource.`getRealmScopeMappings()` Get list of realm-level roles associated with this client's scope.
    `protected Set<RoleRepresentation>` | RoleResource.`getRoleComposites(RoleModel role)`
    `Set<RoleRepresentation>` | RoleByIdResource.`getRoleComposites(String id)` If this role is a composite, return a set of its children
    `Set<RoleRepresentation>` | RoleContainerResource.`getRoleComposites(String roleName)` List composites of this role
    `List<RoleRepresentation>` | RoleContainerResource.`getRoles()` List all roles for this realm or application

    Methods in org.keycloak.services.resources.admin with parameters of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `javax.ws.rs.core.Response` | RoleContainerResource.`createRole(javax.ws.rs.core.UriInfo uriInfo, RoleRepresentation rep)` Create a new role for this realm or application
    `protected void` | RoleResource.`updateRole(RoleRepresentation rep, RoleModel role)`
    `void` | RoleByIdResource.`updateRole(String id, RoleRepresentation rep)` Update this role
    `javax.ws.rs.core.Response` | RoleContainerResource.`updateRole(String roleName, RoleRepresentation rep)` Update a role by name

    Method parameters in org.keycloak.services.resources.admin with type arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | UsersResource.`addApplicationRoleMapping(String username, String appName, List<RoleRepresentation> roles)` Add applicaiton-level roles to the user role mapping.
    `void` | ScopeMappedResource.`addApplicationScopeMapping(String appName, List<RoleRepresentation> roles)` Add application-level roles to the client's scope
    `protected void` | RoleResource.`addComposites(List<RoleRepresentation> roles, RoleModel role)`
    `void` | RoleByIdResource.`addComposites(String id, List<RoleRepresentation> roles)` Make this role a composite role by associating some child roles to it.
    `void` | RoleContainerResource.`addComposites(String roleName, List<RoleRepresentation> roles)` Add a composite to this role
    `void` | UsersResource.`addRealmRoleMappings(String username, List<RoleRepresentation> roles)` Add realm-level role mappings
    `void` | ScopeMappedResource.`addRealmScopeMappings(List<RoleRepresentation> roles)` Add a set of realm-level roles to the client's scope
    `void` | UsersResource.`deleteApplicationRoleMapping(String username, String appName, List<RoleRepresentation> roles)` Delete application-level roles from user role mapping.
    `void` | ScopeMappedResource.`deleteApplicationScopeMapping(String appName, List<RoleRepresentation> roles)` Remove application-level roles from the client's scope.
    `protected void` | RoleResource.`deleteComposites(List<RoleRepresentation> roles, RoleModel role)`
    `void` | RoleByIdResource.`deleteComposites(String id, List<RoleRepresentation> roles)` Remove the listed set of roles from this role's composite
    `void` | RoleContainerResource.`deleteComposites(String roleName, List<RoleRepresentation> roles)` Remove roles from this role's composite
    `void` | UsersResource.`deleteRealmRoleMappings(String username, List<RoleRepresentation> roles)` Delete realm-level role mappings
    `void` | ScopeMappedResource.`deleteRealmScopeMappings(List<RoleRepresentation> roles)` Remove a set of realm-level roles from the client's scope

Copyright © 2014. All Rights Reserved.