Package | Description |
---|---|
org.keycloak.models | |
org.keycloak.storage.client | |
org.keycloak.storage.clientscope | |
org.keycloak.storage.federated |
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 | 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 |
---|---|
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) |
Copyright © 2021 JBoss by Red Hat. All rights reserved.