public interface ClientLookupProvider
Modifier and Type | Method and Description |
---|---|
ClientModel |
getClientByClientId(RealmModel realm,
String clientId)
Exact search for a client by its public client identifier.
|
default ClientModel |
getClientByClientId(String clientId,
RealmModel realm)
Deprecated.
|
ClientModel |
getClientById(RealmModel realm,
String id)
Exact search for a client by its internal ID.
|
default ClientModel |
getClientById(String id,
RealmModel realm)
Deprecated.
|
List<ClientModel> |
searchClientsByClientId(RealmModel realm,
String clientId,
Integer firstResult,
Integer maxResults)
Case-insensitive search for clients that contain the given string in their public client identifier.
|
default List<ClientModel> |
searchClientsByClientId(String clientId,
Integer firstResult,
Integer maxResults,
RealmModel realm)
|
ClientModel getClientById(RealmModel realm, String id)
realm
- Realm to limit the search.id
- Internal IDnull
if no client is found.default ClientModel getClientById(String id, RealmModel realm)
getClientById(org.keycloak.models.RealmModel, java.lang.String)
instead.realm
- Realm to limit the search.id
- Internal IDnull
if no client is found.ClientModel getClientByClientId(RealmModel realm, String clientId)
realm
- Realm to limit the search for clients.clientId
- String that identifies the client to the external parties.
Maps to client_id
in OIDC or entityID
in SAML.null
if no client is found.default ClientModel getClientByClientId(String clientId, RealmModel realm)
getClientByClientId(org.keycloak.models.RealmModel, java.lang.String)
instead.realm
- Realm to limit the search.clientId
- String that identifies the client to the external parties.
Maps to client_id
in OIDC or entityID
in SAML.null
if no client is found.List<ClientModel> searchClientsByClientId(RealmModel realm, String clientId, Integer firstResult, Integer maxResults)
realm
- Realm to limit the search for clients.clientId
- Searched substring of the public client
identifier (client_id
in OIDC or entityID
in SAML.)firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximim number of results to return. Ignored if negative or null
.null
if no client is found.default List<ClientModel> searchClientsByClientId(String clientId, Integer firstResult, Integer maxResults, RealmModel realm)
searchClientsByClientId(org.keycloak.models.RealmModel, java.lang.String, java.lang.Integer, java.lang.Integer)
instead.realm
- Realm to limit the search for clients.clientId
- Searched substring of the public client
identifier (client_id
in OIDC or entityID
in SAML.)firstResult
- First result to return. Ignored if negative or null
.maxResults
- Maximim number of results to return. Ignored if negative or null
.null
.Copyright © 2020 JBoss by Red Hat. All rights reserved.