Package org.keycloak.admin.client.resource

Interface AuthenticationManagementResource

public interface AuthenticationManagementResource
Author:
Marko Strukelj

  • Method Details

    • getFormProviders

      @GET @Path("/form-providers") @Produces("application/json") List<Map<String,Object>> getFormProviders()

    • getAuthenticatorProviders

      @Path("/authenticator-providers") @GET @Produces("application/json") List<Map<String,Object>> getAuthenticatorProviders()

    • getClientAuthenticatorProviders

      @Path("/client-authenticator-providers") @GET @Produces("application/json") List<Map<String,Object>> getClientAuthenticatorProviders()

    • getFormActionProviders

      @Path("/form-action-providers") @GET @Produces("application/json") List<Map<String,Object>> getFormActionProviders()

    • getFlows

      @Path("/flows") @GET @Produces("application/json") List<AuthenticationFlowRepresentation> getFlows()

    • createFlow

      @Path("/flows") @POST @Consumes("application/json") jakarta.ws.rs.core.Response createFlow(AuthenticationFlowRepresentation model)

    • getFlow

      @Path("/flows/{id}") @GET @Produces("application/json") AuthenticationFlowRepresentation getFlow(@PathParam("id") String id)

    • deleteFlow

      @Path("/flows/{id}") @DELETE void deleteFlow(@PathParam("id") String id)

    • copy

      @Path("/flows/{flowAlias}/copy") @POST @Consumes("application/json") jakarta.ws.rs.core.Response copy(@PathParam("flowAlias") String flowAlias, Map<String,Object> data)

    • updateFlow

      @Path("/flows/{id}") @PUT @Consumes("application/json") void updateFlow(@PathParam("id") String id, AuthenticationFlowRepresentation flow)

    • addExecutionFlow

      @Path("/flows/{flowAlias}/executions/flow") @POST @Consumes("application/json") void addExecutionFlow(@PathParam("flowAlias") String flowAlias, Map<String,Object> data)

    • addExecution

      @Path("/flows/{flowAlias}/executions/execution") @POST @Consumes("application/json") void addExecution(@PathParam("flowAlias") String flowAlias, Map<String,Object> data)

    • getExecutions

      @Path("/flows/{flowAlias}/executions") @GET @Produces("application/json") List<AuthenticationExecutionInfoRepresentation> getExecutions(@PathParam("flowAlias") String flowAlias)

    • updateExecutions

      @Path("/flows/{flowAlias}/executions") @PUT @Consumes("application/json") void updateExecutions(@PathParam("flowAlias") String flowAlias, AuthenticationExecutionInfoRepresentation rep)

    • addExecution

      @Path("/executions") @POST @Consumes("application/json") jakarta.ws.rs.core.Response addExecution(AuthenticationExecutionRepresentation model)

    • getExecution

      @Path("/executions/{executionId}") @GET @Produces("application/json") AuthenticationExecutionRepresentation getExecution(@PathParam("executionId") String executionId)

    • raisePriority

      @Path("/executions/{executionId}/raise-priority") @POST void raisePriority(@PathParam("executionId") String execution)

    • lowerPriority

      @Path("/executions/{executionId}/lower-priority") @POST void lowerPriority(@PathParam("executionId") String execution)

    • removeExecution

      @Path("/executions/{executionId}") @DELETE void removeExecution(@PathParam("executionId") String execution)

    • newExecutionConfig

      @Path("/executions/{executionId}/config") @POST @Consumes("application/json") jakarta.ws.rs.core.Response newExecutionConfig(@PathParam("executionId") String executionId, AuthenticatorConfigRepresentation config)

    • getUnregisteredRequiredActions

      @Path("unregistered-required-actions") @GET @Produces("application/json") List<RequiredActionProviderSimpleRepresentation> getUnregisteredRequiredActions()

    • registerRequiredAction

      @Path("register-required-action") @POST @Consumes("application/json") void registerRequiredAction(RequiredActionProviderSimpleRepresentation action)

    • getRequiredActions

      @Path("required-actions") @GET @Produces("application/json") List<RequiredActionProviderRepresentation> getRequiredActions()

    • getRequiredAction

      @Path("required-actions/{alias}") @GET @Produces("application/json") RequiredActionProviderRepresentation getRequiredAction(@PathParam("alias") String alias)

    • updateRequiredAction

      @Path("required-actions/{alias}") @PUT @Consumes("application/json") void updateRequiredAction(@PathParam("alias") String alias, RequiredActionProviderRepresentation rep)

    • removeRequiredAction

      @Path("required-actions/{alias}") @DELETE void removeRequiredAction(@PathParam("alias") String alias)

    • raiseRequiredActionPriority

      @Path("required-actions/{alias}/raise-priority") @POST void raiseRequiredActionPriority(@PathParam("alias") String alias)

    • lowerRequiredActionPriority

      @Path("required-actions/{alias}/lower-priority") @POST void lowerRequiredActionPriority(@PathParam("alias") String alias)

    • getRequiredActionConfigDescription

      @Path("required-actions/{alias}/config-description") @GET @Produces("application/json") RequiredActionConfigInfoRepresentation getRequiredActionConfigDescription(@PathParam("alias") String alias)
      Returns configuration description of the specified required action
      Parameters:
      alias - Alias of the required action, which configuration description will be returned
      Returns:
      Configuration description of the required action
      Throws:
      jakarta.ws.rs.NotFoundException - if the required action of specified alias is not found
      Since:
      Keycloak server 25

    • getRequiredActionConfig

      @Path("required-actions/{alias}/config") @GET @Produces("application/json") RequiredActionConfigRepresentation getRequiredActionConfig(@PathParam("alias") String alias)
      Returns configuration of the specified required action
      Parameters:
      alias - Alias of the required action, which configuration will be returned
      Returns:
      Configuration of the required action
      Throws:
      jakarta.ws.rs.BadRequestException - if required action not configurable
      jakarta.ws.rs.NotFoundException - if the required action configuration of specified alias is not found
      Since:
      Keycloak server 25

    • removeRequiredActionConfig

      @Path("required-actions/{alias}/config") @DELETE void removeRequiredActionConfig(@PathParam("alias") String alias)
      Delete configuration of the specified required action
      Parameters:
      alias - Alias of the required action, which will be removed
      Throws:
      jakarta.ws.rs.BadRequestException - if required action not configurable
      jakarta.ws.rs.NotFoundException - if the required action configuration of specified alias is not found
      Since:
      Keycloak server 25

    • updateRequiredActionConfig

      @Path("required-actions/{alias}/config") @PUT @Consumes("application/json") void updateRequiredActionConfig(@PathParam("alias") String alias, RequiredActionConfigRepresentation rep)
      Update configuration of the required action
      Parameters:
      alias - Alias of the required action, which will be updated
      rep - JSON representation of the required action
      Throws:
      jakarta.ws.rs.BadRequestException - if required action not configurable or given configuration is incorrect
      jakarta.ws.rs.NotFoundException - if the required action configuration of specified alias is not found
      Since:
      Keycloak server 25

    • getAuthenticatorConfigDescription

      @Path("config-description/{providerId}") @GET @Produces("application/json") AuthenticatorConfigInfoRepresentation getAuthenticatorConfigDescription(@PathParam("providerId") String providerId)

    • getPerClientConfigDescription

      @Path("per-client-config-description") @GET @Produces("application/json") Map<String,List<ConfigPropertyRepresentation>> getPerClientConfigDescription()

    • getAuthenticatorConfig

      @Path("config/{id}") @GET @Produces("application/json") AuthenticatorConfigRepresentation getAuthenticatorConfig(@PathParam("id") String id)

    • removeAuthenticatorConfig

      @Path("config/{id}") @DELETE void removeAuthenticatorConfig(@PathParam("id") String id)

    • updateAuthenticatorConfig

      @Path("config/{id}") @PUT @Consumes("application/json") void updateAuthenticatorConfig(@PathParam("id") String id, AuthenticatorConfigRepresentation config)