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

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

- - ### 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.partialimport

    Methods in org.keycloak.partialimport that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `List<RoleRepresentation>` | RealmRolesPartialImport.`getRepList(PartialImportRepresentation partialImportRep)`
    `Map<String,List<RoleRepresentation>>` | ClientRolesPartialImport.`getRepList(PartialImportRepresentation partialImportRep)`
    `Set<RoleRepresentation>` | RealmRolesPartialImport.`getToOverwrite()`
    `Map<String,Set<RoleRepresentation>>` | ClientRolesPartialImport.`getToOverwrite()`
    `Set<RoleRepresentation>` | RealmRolesPartialImport.`getToSkip()`
    `Map<String,Set<RoleRepresentation>>` | ClientRolesPartialImport.`getToSkip()`

    Methods in org.keycloak.partialimport with parameters of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `PartialImportResult` | ClientRolesPartialImport.`added(String clientId, String modelId, RoleRepresentation roleRep)`
    `void` | RealmRolesPartialImport.`create(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)`
    `void` | ClientRolesPartialImport.`deleteRole(RealmModel realm, String clientId, RoleRepresentation roleRep)`
    `boolean` | RealmRolesPartialImport.`exists(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)`
    `boolean` | ClientRolesPartialImport.`exists(RealmModel realm, KeycloakSession session, String clientId, RoleRepresentation roleRep)`
    `String` | RealmRolesPartialImport.`existsMessage(RoleRepresentation roleRep)`
    `String` | ClientRolesPartialImport.`existsMessage(String clientId, RoleRepresentation roleRep)`
    `String` | ClientRolesPartialImport.`getCombinedName(String clientId, RoleRepresentation roleRep)`
    `String` | RealmRolesPartialImport.`getModelId(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)`
    `String` | RealmRolesPartialImport.`getName(RoleRepresentation roleRep)`
    `String` | ClientRolesPartialImport.`getName(RoleRepresentation roleRep)`
    `PartialImportResult` | ClientRolesPartialImport.`overwritten(String clientId, String modelId, RoleRepresentation roleRep)`
    `void` | RealmRolesPartialImport.`remove(RealmModel realm, KeycloakSession session, RoleRepresentation roleRep)`
    `PartialImportResult` | ClientRolesPartialImport.`skipped(String clientId, String modelId, 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` Deprecated.
    `protected Map<String,List<RoleRepresentation>>` | RolesRepresentation.`client`
    `protected List<RoleRepresentation>` | ClientMappingsRepresentation.`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()` Deprecated.
    `Map<String,List<RoleRepresentation>>` | RolesRepresentation.`getClient()`
    `List<RoleRepresentation>` | ClientMappingsRepresentation.`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.`setClient(Map<String,List<RoleRepresentation>> client)`
    `void` | ClientMappingsRepresentation.`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` | RoleContainerResource.`getRole(String roleName)` Get a role by name
    `RoleRepresentation` | RoleByIdResource.`getRole(String id)` Get a specific role's representation

    Methods in org.keycloak.services.resources.admin that return types with arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `static List<RoleRepresentation>` | ScopeMappedResource.`getAvailable(ScopeContainerModel client, Set<RoleModel> roles)`
    `List<RoleRepresentation>` | ClientRoleMappingsResource.`getAvailableClientRoleMappings()` Get available client-level roles that can be mapped to the user
    `List<RoleRepresentation>` | ScopeMappedClientResource.`getAvailableClientScopeMappings()` The available client-level roles Returns the roles for the client that can be associated with the client's scope
    `List<RoleRepresentation>` | RoleMapperResource.`getAvailableRealmRoleMappings()` Get realm-level roles that can be mapped
    `List<RoleRepresentation>` | ScopeMappedResource.`getAvailableRealmScopeMappings()` Get realm-level roles that are available to attach to this client's scope
    `static List<RoleRepresentation>` | ClientRoleMappingsResource.`getAvailableRoles(RoleMapperModel mapper, Set<RoleModel> available)`
    `protected Set<RoleRepresentation>` | RoleResource.`getClientRoleComposites(ClientModel app, RoleModel role)`
    `Set<RoleRepresentation>` | RoleByIdResource.`getClientRoleComposites(String id, String client)` Get client-level roles for the client that are in the role's composite
    `Set<RoleRepresentation>` | RoleContainerResource.`getClientRoleComposites(javax.ws.rs.core.UriInfo uriInfo, String roleName, String client)` An app-level roles for the specified app for the role's composite
    `List<RoleRepresentation>` | ClientRoleMappingsResource.`getClientRoleMappings()` Get client-level role mappings for the user, and the app
    `List<RoleRepresentation>` | ScopeMappedClientResource.`getClientScopeMappings()` Get the roles associated with a client's scope Returns roles for the client.
    `static List<RoleRepresentation>` | ScopeMappedResource.`getComposite(ScopeContainerModel client, Set<RoleModel> roles)`
    `List<RoleRepresentation>` | ClientRoleMappingsResource.`getCompositeClientRoleMappings()` Get effective client-level role mappings This recurses any composite roles
    `List<RoleRepresentation>` | ScopeMappedClientResource.`getCompositeClientScopeMappings()` Get effective client roles Returns the roles for the client that are associated with the client's scope.
    `List<RoleRepresentation>` | RoleMapperResource.`getCompositeRealmRoleMappings()` Get effective realm-level role mappings This will recurse all composite roles to get the result.
    `List<RoleRepresentation>` | ScopeMappedResource.`getCompositeRealmScopeMappings()` Get effective realm-level roles associated with the client's scope What this does is recurse any composite roles associated with the client's scope and adds the roles to this lists.
    `protected Set<RoleRepresentation>` | RoleResource.`getRealmRoleComposites(RoleModel role)`
    `Set<RoleRepresentation>` | RoleContainerResource.`getRealmRoleComposites(String roleName)` Get realm-level roles of the role's composite
    `Set<RoleRepresentation>` | RoleByIdResource.`getRealmRoleComposites(String id)` Get realm-level roles that are in the role's composite
    `List<RoleRepresentation>` | RoleMapperResource.`getRealmRoleMappings()` Get realm-level role mappings
    `List<RoleRepresentation>` | ScopeMappedResource.`getRealmScopeMappings()` Get realm-level roles associated with the client's scope
    `protected Set<RoleRepresentation>` | RoleResource.`getRoleComposites(RoleModel role)`
    `Set<RoleRepresentation>` | RoleContainerResource.`getRoleComposites(String roleName)` Get composites of the role
    `Set<RoleRepresentation>` | RoleByIdResource.`getRoleComposites(String id)` Get role's children Returns a set of role's children provided the role is a composite.
    `List<RoleRepresentation>` | RoleContainerResource.`getRoles()` Get all roles for the realm or client

    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(RoleRepresentation rep)` Create a new role for the realm or client
    `protected void` | RoleResource.`updateRole(RoleRepresentation rep, RoleModel role)`
    `javax.ws.rs.core.Response` | RoleContainerResource.`updateRole(String roleName, RoleRepresentation rep)` Update a role by name
    `void` | RoleByIdResource.`updateRole(String id, RoleRepresentation rep)` Update the role

    Method parameters in org.keycloak.services.resources.admin with type arguments of type RoleRepresentation
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientRoleMappingsResource.`addClientRoleMapping(List<RoleRepresentation> roles)` Add client-level roles to the user role mapping
    `void` | ScopeMappedClientResource.`addClientScopeMapping(List<RoleRepresentation> roles)` Add client-level roles to the client's scope
    `protected void` | RoleResource.`addComposites(AdminEventBuilder adminEvent, javax.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)`
    `void` | RoleContainerResource.`addComposites(String roleName, List<RoleRepresentation> roles)` Add a composite to the role
    `void` | RoleByIdResource.`addComposites(String id, List<RoleRepresentation> roles)` Make the role a composite role by associating some child roles
    `void` | RoleMapperResource.`addRealmRoleMappings(List<RoleRepresentation> roles)` Add realm-level role mappings to the user
    `void` | ScopeMappedResource.`addRealmScopeMappings(List<RoleRepresentation> roles)` Add a set of realm-level roles to the client's scope
    `void` | ClientRoleMappingsResource.`deleteClientRoleMapping(List<RoleRepresentation> roles)` Delete client-level roles from user role mapping
    `void` | ScopeMappedClientResource.`deleteClientScopeMapping(List<RoleRepresentation> roles)` Remove client-level roles from the client's scope.
    `protected void` | RoleResource.`deleteComposites(AdminEventBuilder adminEvent, javax.ws.rs.core.UriInfo uriInfo, List<RoleRepresentation> roles, RoleModel role)`
    `void` | RoleContainerResource.`deleteComposites(String roleName, List<RoleRepresentation> roles)` Remove roles from the role's composite
    `void` | RoleByIdResource.`deleteComposites(String id, List<RoleRepresentation> roles)` Remove a set of roles from the role's composite
    `void` | RoleMapperResource.`deleteRealmRoleMappings(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 © 2016 JBoss by Red Hat. All rights reserved.