Modifier and Type | Method and Description |
---|---|
LoginFormsProvider |
LoginFormsProvider.setAccessRequest(List<ClientScopeModel> clientScopesRequested) |
Modifier and Type | Field and Description |
---|---|
protected List<ClientScopeModel> |
FreeMarkerLoginFormsProvider.clientScopesRequested |
Modifier and Type | Method and Description |
---|---|
LoginFormsProvider |
FreeMarkerLoginFormsProvider.setAccessRequest(List<ClientScopeModel> clientScopesRequested) |
Constructor and Description |
---|
OAuthGrantBean(String code,
ClientModel client,
List<ClientScopeModel> clientScopesRequested) |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
MigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm)
Adds the
microprofile-jwt optional client scope to the realm and returns the created scope. |
ClientScopeModel |
MigrationProvider.addOIDCRolesClientScope(RealmModel realm)
Add 'roles' client scope or return it if already exists
|
ClientScopeModel |
MigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm)
Add 'web-origins' client scope or return it if already exists
|
Modifier and Type | Interface and Description |
---|---|
interface |
ClientModel |
Modifier and Type | Field and Description |
---|---|
static SearchableModelField<ClientScopeModel> |
ClientScopeModel.SearchableFields.ID |
static SearchableModelField<ClientScopeModel> |
ClientScopeModel.SearchableFields.NAME |
static SearchableModelField<ClientScopeModel> |
ClientScopeModel.SearchableFields.REALM_ID |
Modifier and Type | Method and Description |
---|---|
default ClientScopeModel |
ClientScopeProvider.addClientScope(RealmModel realm,
String name)
Creates new client scope with given
name to the given realm. |
ClientScopeModel |
ClientScopeProvider.addClientScope(RealmModel realm,
String id,
String name)
Creates new client scope with given internal ID and
name to the given realm. |
ClientScopeModel |
RealmModel.addClientScope(String name)
Creates new client scope with the given name.
|
ClientScopeModel |
RealmModel.addClientScope(String id,
String name)
Creates new client scope with the given internal ID and name.
|
ClientScopeModel |
ClientScopeModel.ClientScopeRemovedEvent.getClientScope() |
ClientScopeModel |
RealmProvider.getClientScopeById(RealmModel realm,
String id)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
ClientScopeModel |
RealmModel.getClientScopeById(String id) |
default ClientScopeModel |
RealmProvider.getClientScopeById(String id,
RealmModel realm)
Deprecated.
Use the corresponding method from
ClientScopeProvider . |
default ClientScopeModel |
ClientModel.getDynamicClientScope(String scope)
Returns a
ClientScopeModel associated with this client. |
Modifier and Type | Method and Description |
---|---|
default List<ClientScopeModel> |
RealmModel.getClientScopes()
Deprecated.
Use
getClientScopesStream instead. |
default Set<ClientScopeModel> |
ClientSessionContext.getClientScopes()
Deprecated.
Use
getClientScopesStream instead. |
Map<String,ClientScopeModel> |
ClientModel.getClientScopes(boolean defaultScope)
Return all default scopes (if 'defaultScope' is true) or all optional scopes (if 'defaultScope' is false) linked with this client
|
Stream<ClientScopeModel> |
RealmModel.getClientScopesStream()
Returns all client scopes of this realm as a stream.
|
Stream<ClientScopeModel> |
ClientSessionContext.getClientScopesStream()
Returns client scopes as a stream.
|
Stream<ClientScopeModel> |
ClientScopeProvider.getClientScopesStream(RealmModel realm)
Returns all the client scopes of the given realm as a stream.
|
default List<ClientScopeModel> |
RealmModel.getDefaultClientScopes(boolean defaultScope)
Deprecated.
Use
getDefaultClientScopesStream instead. |
Stream<ClientScopeModel> |
RealmModel.getDefaultClientScopesStream(boolean defaultScope)
Returns default client scopes of this realm either default ones or optional ones.
|
Set<ClientScopeModel> |
UserConsentModel.getGrantedClientScopes() |
Modifier and Type | Method and Description |
---|---|
void |
ClientModel.addClientScope(ClientScopeModel clientScope,
boolean defaultScope)
Add clientScope with this client.
|
void |
RealmModel.addDefaultClientScope(ClientScopeModel clientScope,
boolean defaultScope)
Adds given client scope among default/optional client scopes of this realm.
|
void |
UserConsentModel.addGrantedClientScope(ClientScopeModel clientScope) |
boolean |
UserConsentModel.isClientScopeGranted(ClientScopeModel clientScope) |
void |
UserProvider.preRemove(ClientScopeModel clientScope)
Called when a client scope is removed.
|
void |
ClientModel.removeClientScope(ClientScopeModel clientScope) |
void |
ClientProvider.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope)
Unassign clientScope from the client.
|
void |
RealmModel.removeDefaultClientScope(ClientScopeModel clientScope)
Removes given client scope from default or optional client scopes of this realm.
|
Modifier and Type | Method and Description |
---|---|
void |
ClientProvider.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope)
Assign clientScopes to the client.
|
void |
ClientModel.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope)
Add clientScopes with this client.
|
Modifier and Type | Field and Description |
---|---|
protected ClientScopeModel |
ClientScopeAdapter.updated |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
RealmCacheSession.addClientScope(RealmModel realm,
String name) |
ClientScopeModel |
RealmCacheSession.addClientScope(RealmModel realm,
String id,
String name) |
ClientScopeModel |
RealmAdapter.addClientScope(String name) |
ClientScopeModel |
RealmAdapter.addClientScope(String id,
String name) |
ClientScopeModel |
RealmCacheSession.getClientScopeById(RealmModel realm,
String id) |
ClientScopeModel |
RealmAdapter.getClientScopeById(String id) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
ClientAdapter.getClientScopes(boolean defaultScope) |
Map<String,ClientScopeModel> |
RealmCacheSession.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes) |
Stream<ClientScopeModel> |
RealmAdapter.getClientScopesStream() |
Stream<ClientScopeModel> |
RealmCacheSession.getClientScopesStream(RealmModel realm) |
Stream<ClientScopeModel> |
RealmAdapter.getDefaultClientScopesStream(boolean defaultScope) |
Modifier and Type | Method and Description |
---|---|
void |
ClientAdapter.addClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
RealmAdapter.addDefaultClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
UserCacheSession.preRemove(ClientScopeModel clientScope) |
void |
ClientAdapter.removeClientScope(ClientScopeModel clientScope) |
void |
RealmCacheSession.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope) |
void |
RealmAdapter.removeDefaultClientScope(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
RealmCacheSession.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
void |
ClientAdapter.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Constructor and Description |
---|
CachedClientScope(Long revision,
RealmModel realm,
ClientScopeModel model) |
Modifier and Type | Class and Description |
---|---|
class |
ClientModelLazyDelegate |
static class |
ClientModelLazyDelegate.WithId |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
ClientModelLazyDelegate.getDynamicClientScope(String scope) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
ClientModelLazyDelegate.getClientScopes(boolean defaultScope) |
Modifier and Type | Method and Description |
---|---|
void |
ClientModelLazyDelegate.addClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
ClientModelLazyDelegate.removeClientScope(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
ClientModelLazyDelegate.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Modifier and Type | Class and Description |
---|---|
class |
ClientAdapter |
class |
ClientScopeAdapter |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
JpaRealmProvider.addClientScope(RealmModel realm,
String id,
String name) |
ClientScopeModel |
RealmAdapter.addClientScope(String name) |
ClientScopeModel |
RealmAdapter.addClientScope(String id,
String name) |
ClientScopeModel |
JpaRealmProvider.getClientScopeById(RealmModel realm,
String id) |
ClientScopeModel |
RealmAdapter.getClientScopeById(String id) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
ClientAdapter.getClientScopes(boolean defaultScope) |
Map<String,ClientScopeModel> |
JpaRealmProvider.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScope) |
Stream<ClientScopeModel> |
RealmAdapter.getClientScopesStream() |
Stream<ClientScopeModel> |
JpaRealmProvider.getClientScopesStream(RealmModel realm) |
Stream<ClientScopeModel> |
RealmAdapter.getDefaultClientScopesStream(boolean defaultScope) |
Modifier and Type | Method and Description |
---|---|
void |
ClientAdapter.addClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
RealmAdapter.addDefaultClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
JpaUserProvider.preRemove(ClientScopeModel clientScope) |
void |
ClientAdapter.removeClientScope(ClientScopeModel clientScope) |
void |
JpaRealmProvider.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope) |
void |
RealmAdapter.removeDefaultClientScope(ClientScopeModel clientScope) |
static ClientScopeEntity |
ClientScopeAdapter.toClientScopeEntity(ClientScopeModel model,
javax.persistence.EntityManager em) |
Modifier and Type | Method and Description |
---|---|
void |
JpaRealmProvider.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
void |
ClientAdapter.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractClientModel<E extends AbstractEntity> |
class |
MapClientAdapter<K> |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
AbstractClientModel.getClientScopes(boolean defaultScope) |
Map<String,ClientScopeModel> |
MapClientProvider.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractClientModel.addClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
AbstractClientModel.removeClientScope(ClientScopeModel clientScope) |
void |
MapClientProvider.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
MapClientProvider.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
void |
AbstractClientModel.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractClientScopeModel<E extends AbstractEntity> |
class |
MapClientScopeAdapter<K> |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
MapClientScopeProvider.addClientScope(RealmModel realm,
String id,
String name) |
ClientScopeModel |
MapClientScopeProvider.getClientScopeById(RealmModel realm,
String id) |
Modifier and Type | Method and Description |
---|---|
Stream<ClientScopeModel> |
MapClientScopeProvider.getClientScopesStream(RealmModel realm) |
Constructor and Description |
---|
MapClientScopeProvider(KeycloakSession session,
MapStorage<K,MapClientScopeEntity<K>,ClientScopeModel> clientScopeStore) |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
MapRealmProvider.addClientScope(RealmModel realm,
String id,
String name)
Deprecated.
|
ClientScopeModel |
MapRealmAdapter.addClientScope(String name) |
ClientScopeModel |
MapRealmAdapter.addClientScope(String id,
String name) |
ClientScopeModel |
MapRealmProvider.getClientScopeById(RealmModel realm,
String id)
Deprecated.
|
ClientScopeModel |
MapRealmAdapter.getClientScopeById(String id) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
MapRealmProvider.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes)
Deprecated.
|
Stream<ClientScopeModel> |
MapRealmAdapter.getClientScopesStream() |
Stream<ClientScopeModel> |
MapRealmProvider.getClientScopesStream(RealmModel realm)
Deprecated.
|
Stream<ClientScopeModel> |
MapRealmAdapter.getDefaultClientScopesStream(boolean defaultScope) |
Modifier and Type | Method and Description |
---|---|
void |
MapRealmAdapter.addDefaultClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
MapRealmProvider.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope)
Deprecated.
|
void |
MapRealmAdapter.removeDefaultClientScope(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
MapRealmProvider.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope)
Deprecated.
|
Modifier and Type | Field and Description |
---|---|
static Map<SearchableModelField<ClientScopeModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapClientScopeEntity<Object>,ClientScopeModel>> |
MapFieldPredicates.CLIENT_SCOPE_PREDICATES |
static Map<SearchableModelField<ClientScopeModel>,MapModelCriteriaBuilder.UpdatePredicatesFunc<Object,MapClientScopeEntity<Object>,ClientScopeModel>> |
MapFieldPredicates.CLIENT_SCOPE_PREDICATES |
Modifier and Type | Method and Description |
---|---|
void |
MapUserProvider.preRemove(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
static ClientScopeModel |
RepresentationToModel.createClientScope(KeycloakSession session,
RealmModel realm,
ClientScopeRepresentation resourceRep) |
static ClientScopeModel |
KeycloakModelUtils.findClientScopeById(RealmModel realm,
ClientModel client,
String clientScopeId)
Lookup clientScope OR client by id.
|
static ClientScopeModel |
KeycloakModelUtils.getClientScopeByName(RealmModel realm,
String clientScopeName) |
Modifier and Type | Method and Description |
---|---|
static ClientScopeRepresentation |
ModelToRepresentation.toRepresentation(ClientScopeModel clientScopeModel) |
static void |
RepresentationToModel.updateClientScope(ClientScopeRepresentation rep,
ClientScopeModel resource) |
Modifier and Type | Method and Description |
---|---|
static ClientScopeModel |
OIDCLoginProtocolFactory.addMicroprofileJWTClientScope(RealmModel newRealm)
Adds the
microprofile-jwt optional client scope to the specified realm. |
static ClientScopeModel |
OIDCLoginProtocolFactory.addRolesClientScope(RealmModel newRealm) |
static ClientScopeModel |
OIDCLoginProtocolFactory.addWebOriginsClientScope(RealmModel newRealm) |
Modifier and Type | Method and Description |
---|---|
static Stream<ClientScopeModel> |
TokenManager.getRequestedClientScopes(String scopeParam,
ClientModel client)
Return client itself + all default client scopes of client + optional client scopes requested by scope parameter
|
Modifier and Type | Method and Description |
---|---|
static Set<RoleModel> |
TokenManager.getAccess(UserModel user,
ClientModel client,
Stream<ClientScopeModel> clientScopes) |
static boolean |
TokenManager.verifyConsentStillAvailable(KeycloakSession session,
UserModel user,
ClientModel client,
Stream<ClientScopeModel> requestedClientScopes) |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
DefaultMigrationProvider.addOIDCMicroprofileJWTClientScope(RealmModel realm) |
ClientScopeModel |
DefaultMigrationProvider.addOIDCRolesClientScope(RealmModel realm) |
ClientScopeModel |
DefaultMigrationProvider.addOIDCWebOriginsClientScope(RealmModel realm) |
Modifier and Type | Field and Description |
---|---|
protected ClientScopeModel |
ClientScopeResource.clientScope |
Constructor and Description |
---|
ClientScopeResource(RealmModel realm,
AdminPermissionEvaluator auth,
ClientScopeModel clientScope,
KeycloakSession session,
AdminEventBuilder adminEvent) |
Modifier and Type | Method and Description |
---|---|
boolean |
ClientPermissionEvaluator.canManage(ClientScopeModel clientScope) |
boolean |
ClientPermissionEvaluator.canView(ClientScopeModel clientScope) |
void |
ClientPermissionEvaluator.requireManage(ClientScopeModel clientScope) |
void |
ClientPermissionEvaluator.requireView(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
Stream<ClientScopeModel> |
DefaultClientSessionContext.getClientScopesStream() |
Modifier and Type | Method and Description |
---|---|
static DefaultClientSessionContext |
DefaultClientSessionContext.fromClientSessionAndClientScopes(AuthenticatedClientSessionModel clientSession,
Stream<ClientScopeModel> clientScopes,
KeycloakSession session) |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
ClientScopeStorageManager.addClientScope(RealmModel realm,
String id,
String name) |
ClientScopeModel |
ClientScopeStorageManager.getClientScopeById(RealmModel realm,
String id) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
ClientStorageManager.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes) |
Stream<ClientScopeModel> |
ClientScopeStorageManager.getClientScopesStream(RealmModel realm) |
Modifier and Type | Method and Description |
---|---|
void |
UserStorageManager.preRemove(ClientScopeModel clientScope) |
void |
ClientStorageManager.removeClientScope(RealmModel realm,
ClientModel client,
ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
ClientStorageManager.addClientScopes(RealmModel realm,
ClientModel client,
Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractClientStorageAdapter
Helper base class for ClientModel implementations for ClientStorageProvider implementations.
|
class |
AbstractReadOnlyClientScopeAdapter |
class |
AbstractReadOnlyClientStorageAdapter |
class |
UnsupportedOperationsClientStorageAdapter
Base helper class.
|
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
ClientLookupProvider.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes)
Return all default scopes (if
defaultScope is true ) or all optional scopes (if defaultScope is false ) linked with the client |
Modifier and Type | Method and Description |
---|---|
void |
AbstractReadOnlyClientStorageAdapter.addClientScope(ClientScopeModel clientScope,
boolean defaultScope) |
void |
AbstractReadOnlyClientStorageAdapter.removeClientScope(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
AbstractReadOnlyClientStorageAdapter.addClientScopes(Set<ClientScopeModel> clientScopes,
boolean defaultScope) |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
ClientScopeLookupProvider.getClientScopeById(RealmModel realm,
String id)
Exact search for a client scope by its internal ID..
|
Modifier and Type | Method and Description |
---|---|
void |
UserFederatedStorageProvider.preRemove(ClientScopeModel clientScope) |
Modifier and Type | Method and Description |
---|---|
void |
JpaUserFederatedStorageProvider.preRemove(ClientScopeModel clientScope) |
Modifier and Type | Class and Description |
---|---|
class |
OpenshiftSAClientAdapter |
Modifier and Type | Method and Description |
---|---|
ClientScopeModel |
OpenshiftSAClientAdapter.getDynamicClientScope(String scope) |
Modifier and Type | Method and Description |
---|---|
Map<String,ClientScopeModel> |
OpenshiftSAClientAdapter.getClientScopes(boolean defaultScope) |
Map<String,ClientScopeModel> |
OpenshiftClientStorageProvider.getClientScopes(RealmModel realm,
ClientModel client,
boolean defaultScopes) |
Copyright © 2021 JBoss by Red Hat. All rights reserved.