Package org.keycloak.admin.client.resource

Interface RealmResource

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

  • Method Details

    • toRepresentation

      @GET @Produces("application/json") RealmRepresentation toRepresentation()

    • update

      @PUT @Consumes("application/json") void update(RealmRepresentation realmRepresentation)

    • clients

      @Path("clients") ClientsResource clients()

    • clientScopes

      @Path("client-scopes") ClientScopesResource clientScopes()

    • getDefaultDefaultClientScopes

      @GET @Produces("application/json") @Path("default-default-client-scopes") List<ClientScopeRepresentation> getDefaultDefaultClientScopes()

    • addDefaultDefaultClientScope

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

    • removeDefaultDefaultClientScope

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

    • getDefaultOptionalClientScopes

      @GET @Produces("application/json") @Path("default-optional-client-scopes") List<ClientScopeRepresentation> getDefaultOptionalClientScopes()

    • addDefaultOptionalClientScope

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

    • removeDefaultOptionalClientScope

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

    • convertClientDescription

      @Path("client-description-converter") @POST @Consumes("application/json") @Produces("application/json") ClientRepresentation convertClientDescription(String description)

    • users

      @Path("users") UsersResource users()

    • roles

      @Path("roles") RolesResource roles()

    • rolesById

      @Path("roles-by-id") RoleByIdResource rolesById()

    • groups

      @Path("groups") GroupsResource groups()

    • clearEvents

      @DELETE @Path("events") void clearEvents()

    • getEvents

      @GET @Path("events") @Produces("application/json") List<EventRepresentation> getEvents()

    • getEvents

      @Path("events") @GET @Produces("application/json") List<EventRepresentation> getEvents(@QueryParam("type") List<String> types, @QueryParam("client") String client, @QueryParam("user") String user, @QueryParam("dateFrom") String dateFrom, @QueryParam("dateTo") String dateTo, @QueryParam("ipAddress") String ipAddress, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)

    • clearAdminEvents

      @DELETE @Path("admin-events") void clearAdminEvents()

    • getAdminEvents

      @GET @Path("admin-events") @Produces("application/json") List<AdminEventRepresentation> getAdminEvents()

    • getAdminEvents

      @GET @Path("admin-events") @Produces("application/json") List<AdminEventRepresentation> getAdminEvents(@QueryParam("operationTypes") List<String> operationTypes, @QueryParam("authRealm") String authRealm, @QueryParam("authClient") String authClient, @QueryParam("authUser") String authUser, @QueryParam("authIpAddress") String authIpAddress, @QueryParam("resourcePath") String resourcePath, @QueryParam("dateFrom") String dateFrom, @QueryParam("dateTo") String dateTo, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)

    • getAdminEvents

      @GET @Path("admin-events") @Produces("application/json") List<AdminEventRepresentation> getAdminEvents(@QueryParam("operationTypes") List<String> operationTypes, @QueryParam("authRealm") String authRealm, @QueryParam("authClient") String authClient, @QueryParam("authUser") String authUser, @QueryParam("authIpAddress") String authIpAddress, @QueryParam("resourcePath") String resourcePath, @QueryParam("resourceTypes") List<String> resourceTypes, @QueryParam("dateFrom") String dateFrom, @QueryParam("dateTo") String dateTo, @QueryParam("first") Integer firstResult, @QueryParam("max") Integer maxResults)

    • getRealmEventsConfig

      @GET @Path("events/config") @Produces("application/json") RealmEventsConfigRepresentation getRealmEventsConfig()

    • updateRealmEventsConfig

      @PUT @Path("events/config") @Consumes("application/json") void updateRealmEventsConfig(RealmEventsConfigRepresentation rep)

    • getGroupByPath

      @GET @Path("group-by-path/{path: .*}") @Produces("application/json") GroupRepresentation getGroupByPath(@PathParam("path") String path)

    • getDefaultGroups

      @GET @Produces("application/json") @Path("default-groups") List<GroupRepresentation> getDefaultGroups()

    • addDefaultGroup

      @PUT @Path("default-groups/{groupId}") void addDefaultGroup(@PathParam("groupId") String groupId)

    • removeDefaultGroup

      @DELETE @Path("default-groups/{groupId}") void removeDefaultGroup(@PathParam("groupId") String groupId)

    • identityProviders

      @Path("identity-provider") IdentityProvidersResource identityProviders()

    • remove

      @DELETE void remove()

    • getClientSessionStats

      @Path("client-session-stats") @GET List<Map<String,String>> getClientSessionStats()

    • clientInitialAccess

      @Path("clients-initial-access") ClientInitialAccessResource clientInitialAccess()

    • clientRegistrationPolicy

      @Path("client-registration-policy") ClientRegistrationPolicyResource clientRegistrationPolicy()

    • partialImport

      @Path("partialImport") @POST @Consumes("application/json") @Produces("application/json") jakarta.ws.rs.core.Response partialImport(PartialImportRepresentation rep)

    • partialExport

      @Path("partial-export") @POST @Produces("application/json") RealmRepresentation partialExport(@QueryParam("exportGroupsAndRoles") Boolean exportGroupsAndRoles, @QueryParam("exportClients") Boolean exportClients)

    • flows

      @Path("authentication") @Consumes("application/json") AuthenticationManagementResource flows()

    • attackDetection

      @Path("attack-detection") AttackDetectionResource attackDetection()

    • testLDAPConnection

      @Path("testLDAPConnection") @POST @Consumes("application/x-www-form-urlencoded") @Deprecated jakarta.ws.rs.core.Response testLDAPConnection(@FormParam("action") String action, @FormParam("connectionUrl") String connectionUrl, @FormParam("bindDn") String bindDn, @FormParam("bindCredential") String bindCredential, @FormParam("useTruststoreSpi") String useTruststoreSpi, @FormParam("connectionTimeout") String connectionTimeout)
      Deprecated.

    • testLDAPConnection

      @Path("testLDAPConnection") @POST @Consumes("application/json") jakarta.ws.rs.core.Response testLDAPConnection(TestLdapConnectionRepresentation config)

    • ldapServerCapabilities

      @POST @Path("ldap-server-capabilities") @Consumes("application/json") @Produces("application/json") List<LDAPCapabilityRepresentation> ldapServerCapabilities(TestLdapConnectionRepresentation config)

    • testSMTPConnection

      @Path("testSMTPConnection") @POST @Consumes("application/x-www-form-urlencoded") @Deprecated jakarta.ws.rs.core.Response testSMTPConnection(@FormParam("config") String config)
      Deprecated.

    • testSMTPConnection

      @Path("testSMTPConnection") @POST @Consumes("application/json") jakarta.ws.rs.core.Response testSMTPConnection(Map<String,String> config)

    • clearRealmCache

      @Path("clear-realm-cache") @POST void clearRealmCache()

    • clearUserCache

      @Path("clear-user-cache") @POST void clearUserCache()

    • clearKeysCache

      @Path("clear-keys-cache") @POST void clearKeysCache()

    • pushRevocation

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

    • logoutAll

      @Path("logout-all") @POST @Produces("application/json") GlobalRequestResult logoutAll()

    • deleteSession

      @Path("sessions/{session}") @DELETE void deleteSession(@PathParam("session") String sessionId, @DefaultValue("false") @QueryParam("isOffline") boolean offline)

    • components

      @Path("components") ComponentsResource components()

    • userStorage

      @Path("user-storage") UserStorageProviderResource userStorage()

    • keys

      @Path("keys") KeyResource keys()

    • localization

      @Path("localization") RealmLocalizationResource localization()

    • clientPoliciesPoliciesResource

      @Path("client-policies/policies") ClientPoliciesPoliciesResource clientPoliciesPoliciesResource()

    • clientPoliciesProfilesResource

      @Path("client-policies/profiles") ClientPoliciesProfilesResource clientPoliciesProfilesResource()