org.keycloak.admin.client.resource.ClientsResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keycloak-admin-client Show documentation

There is a newer version: 26.0.2

Show newest version

/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.keycloak.admin.client.resource;

import org.keycloak.representations.idm.ClientRepresentation;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.util.List;

/**
 * @author [email protected]
 */
public interface ClientsResource {

    @Path("{id}")
    ClientResource get(@PathParam("id") String id);

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    Response create(ClientRepresentation clientRepresentation);

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List findAll();

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List findAll(@QueryParam("viewableOnly") boolean viewableOnly);

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List findAll(@QueryParam("clientId") String clientId,
                                                 @QueryParam("viewableOnly") Boolean viewableOnly,
                                                 @QueryParam("search") Boolean search,
                                                 @QueryParam("first") Integer firstResult,
                                                 @QueryParam("max") Integer maxResults);

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List findByClientId(@QueryParam("clientId") String clientId);

    @GET
    @Produces(MediaType.APPLICATION_JSON)
    List query(@QueryParam("q") String searchQuery);

}