Package org.keycloak.services.clientpolicy.context

Interface ClientCRUDContext

All Superinterfaces:
org.keycloak.services.clientpolicy.ClientPolicyContext
All Known Subinterfaces:
ClientCRUDClientAvailableContext
All Known Implementing Classes:
AdminClientRegisterContext, AdminClientRegisteredContext, AdminClientUnregisterContext, AdminClientUpdateContext, AdminClientUpdatedContext, AdminClientViewContext, CimdClientRegisterContext, CimdClientRegisteredContext, CimdClientUpdateContext, CimdClientUpdatedContext, ClientSecretRotationContext, DynamicClientRegisterContext, DynamicClientRegisteredContext, DynamicClientUnregisterContext, DynamicClientUpdateContext, DynamicClientUpdatedContext, DynamicClientViewContext
public interface ClientCRUDContext extends org.keycloak.services.clientpolicy.ClientPolicyContext
Represents the context in the request to register/read/update/unregister client by Dynamic Client Registration or Admin REST API.

  • Method Summary

    Modifier and Type
    Method
    Description
    default org.keycloak.models.ClientModel
    getAuthenticatedClient()
    returns UserModel of the authenticated client.
    default org.keycloak.models.UserModel
    getAuthenticatedUser()
    returns UserModel of the authenticated user.
    default org.keycloak.representations.idm.ClientRepresentation
    getProposedClientRepresentation()
    returns ClientRepresentation for creating the new client or updating the existing client.
    default org.keycloak.models.ClientModel
    getTargetClient()
    returns ClientModel of the existing client to be updated/read/updated/deleted.
    default org.keycloak.representations.JsonWebToken
    getToken()
    returns JsonWebToken of the token accompanied with the request to register/read/update/unregister client

    Methods inherited from interface org.keycloak.services.clientpolicy.ClientPolicyContext

    getEvent

  • Method Details

    • getProposedClientRepresentation

      default org.keycloak.representations.idm.ClientRepresentation getProposedClientRepresentation()
      returns ClientRepresentation for creating the new client or updating the existing client.
      Returns:
      ClientRepresentation

    • getTargetClient

      default org.keycloak.models.ClientModel getTargetClient()
      returns ClientModel of the existing client to be updated/read/updated/deleted. on REGISTER event, it returns null.
      Returns:
      ClientModel

    • getAuthenticatedUser

      default org.keycloak.models.UserModel getAuthenticatedUser()
      returns UserModel of the authenticated user.
      Returns:
      UserModel

    • getAuthenticatedClient

      default org.keycloak.models.ClientModel getAuthenticatedClient()
      returns UserModel of the authenticated client.
      Returns:
      UserModel

    • getToken

      default org.keycloak.representations.JsonWebToken getToken()
      returns JsonWebToken of the token accompanied with the request to register/read/update/unregister client
      Returns:
      JsonWebToken