Package org.keycloak.admin.client.resource

Interface ClientResource

public interface ClientResource
Author:
rodrigo.sasaki@icarros.com.br

  • Method Details

    • setPermissions

      @PUT @Path("/management/permissions") @Consumes("application/json") @Produces("application/json") org.keycloak.representations.idm.ManagementPermissionReference setPermissions(org.keycloak.representations.idm.ManagementPermissionRepresentation status)
      Enables or disables the fine grain permissions feature. Returns the updated status of the server in the ManagementPermissionReference.
      Parameters:
      status - status request to apply
      Returns:
      permission reference indicating the updated status

    • getPermissions

      @GET @Path("/management/permissions") @Produces("application/json") org.keycloak.representations.idm.ManagementPermissionReference getPermissions()
      Returns indicator if the fine grain permissions are enabled or not.
      Returns:
      current representation of the permissions feature

    • getProtocolMappers

      @Path("protocol-mappers") ProtocolMappersResource getProtocolMappers()

    • toRepresentation

      @GET @Produces("application/json") org.keycloak.representations.idm.ClientRepresentation toRepresentation()

    • update

      @PUT @Consumes("application/json") void update(org.keycloak.representations.idm.ClientRepresentation clientRepresentation)

    • remove

      @DELETE void remove()

    • generateNewSecret

      @POST @Path("client-secret") @Produces("application/json") org.keycloak.representations.idm.CredentialRepresentation generateNewSecret()

    • getSecret

      @GET @Path("client-secret") @Produces("application/json") org.keycloak.representations.idm.CredentialRepresentation getSecret()

    • regenerateRegistrationAccessToken

      @Path("registration-access-token") @POST @Produces("application/json") @Consumes("application/json") org.keycloak.representations.idm.ClientRepresentation regenerateRegistrationAccessToken()
      Generate a new registration access token for the client
      Returns:

    • getCertficateResource

      @Path("certificates/{attr}") ClientAttributeCertificateResource getCertficateResource(@PathParam("attr") String attributePrefix)
      Get representation of certificate resource
      Parameters:
      attributePrefix -
      Returns:

    • getInstallationProvider

      @GET @Path("installation/providers/{providerId}") String getInstallationProvider(@PathParam("providerId") String providerId)
      Return installation provider as a String. String is typically XML format specific to the requested provider
      Parameters:
      providerId - installation provider ID
      Returns:
      response as a string

    • getInstallationProviderAsResponse

      @GET @Path("installation/providers/{providerId}") jakarta.ws.rs.core.Response getInstallationProviderAsResponse(@PathParam("providerId") String providerId)
      Return installation provider as a response
      Parameters:
      providerId - installation provider ID
      Returns:
      Jakarta response

    • getApplicationSessionCount

      @Path("session-count") @GET @Produces("application/json") Map<String,Integer> getApplicationSessionCount()

    • getUserSessions

      @Path("user-sessions") @GET @Produces("application/json") List<org.keycloak.representations.idm.UserSessionRepresentation> getUserSessions(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)

    • getOfflineSessionCount

      @Path("offline-session-count") @GET @Produces("application/json") Map<String,Long> getOfflineSessionCount()

    • getOfflineUserSessions

      @Path("offline-sessions") @GET @Produces("application/json") List<org.keycloak.representations.idm.UserSessionRepresentation> getOfflineUserSessions(@QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)

    • pushRevocation

      @POST @Path("push-revocation") @Produces("application/json") void pushRevocation()

    • getScopeMappings

      @Path("/scope-mappings") RoleMappingResource getScopeMappings()

    • roles

      @Path("/roles") RolesResource roles()

    • clientScopesEvaluate

      @Path("/evaluate-scopes") ClientScopeEvaluateResource clientScopesEvaluate()

    • getDefaultClientScopes

      @GET @Produces("application/json") @Path("default-client-scopes") List<org.keycloak.representations.idm.ClientScopeRepresentation> getDefaultClientScopes()
      Get default client scopes. Only name and ids are returned.
      Returns:
      default client scopes

    • addDefaultClientScope

      @PUT @Path("default-client-scopes/{clientScopeId}") void addDefaultClientScope(@PathParam("clientScopeId") String clientScopeId)

    • removeDefaultClientScope

      @DELETE @Path("default-client-scopes/{clientScopeId}") void removeDefaultClientScope(@PathParam("clientScopeId") String clientScopeId)

    • getOptionalClientScopes

      @GET @Produces("application/json") @Path("optional-client-scopes") List<org.keycloak.representations.idm.ClientScopeRepresentation> getOptionalClientScopes()
      Get optional client scopes. Only name and ids are returned.
      Returns:
      optional client scopes

    • addOptionalClientScope

      @PUT @Path("optional-client-scopes/{clientScopeId}") void addOptionalClientScope(@PathParam("clientScopeId") String clientScopeId)

    • removeOptionalClientScope

      @DELETE @Path("optional-client-scopes/{clientScopeId}") void removeOptionalClientScope(@PathParam("clientScopeId") String clientScopeId)

    • getServiceAccountUser

      @Path("/service-account-user") @GET @Produces("application/json") org.keycloak.representations.idm.UserRepresentation getServiceAccountUser()

    • registerNode

      @Path("nodes") @POST @Consumes("application/json") void registerNode(Map<String,String> formParams)

    • unregisterNode

      @Path("nodes/{node}") @DELETE void unregisterNode(@PathParam("node") String node)

    • testNodesAvailable

      @Path("test-nodes-available") @GET @Produces("application/json") org.keycloak.representations.adapters.action.GlobalRequestResult testNodesAvailable()

    • authorization

      @Path("/authz/resource-server") AuthorizationResource authorization()

    • getClientRotatedSecret

      @Path("client-secret/rotated") @GET @Produces("application/json") org.keycloak.representations.idm.CredentialRepresentation getClientRotatedSecret()

    • invalidateRotatedSecret

      @Path("client-secret/rotated") @DELETE @Produces("application/json") @Consumes("application/json") void invalidateRotatedSecret()