com.symphony.api.pod.InfoBarriersApi Maven / Gradle / Ivy
package com.symphony.api.pod;
import com.symphony.api.model.BulkActionResult;
import com.symphony.api.model.Error;
import com.symphony.api.model.GroupList;
import com.symphony.api.model.IntegerList;
import com.symphony.api.model.PolicyList;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.ext.multipart.*;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.responses.ApiResponses;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.media.ArraySchema;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
/**
* Pod API
*
* This document refers to Symphony API calls that do not need encryption or decryption of content. - sessionToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have made no change to the system even if ome subset of the request would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X.
*
*/
@Path("/")
public interface InfoBarriersApi {
/**
* Add members to an Information Barrier group.
*
*/
@POST
@Path("/v1/admin/group/{gid}/membership/add")
@Consumes({ "application/json" })
@Produces({ "application/json" })
@Operation(summary = "Add members to an Information Barrier group.", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = BulkActionResult.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public BulkActionResult v1AdminGroupGidMembershipAddPost(List body, @HeaderParam("sessionToken") String sessionToken, @PathParam("gid") String gid);
/**
* Get the list of userids in this Information Barrier Group
*
*/
@GET
@Path("/v1/admin/group/{gid}/membership/list")
@Produces({ "application/json" })
@Operation(summary = "Get the list of userids in this Information Barrier Group", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = IntegerList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "404", description = "Not Found: Group cannot be found.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public IntegerList v1AdminGroupGidMembershipListGet(@PathParam("gid") String gid, @HeaderParam("sessionToken") String sessionToken);
/**
* Remove members from an Information Barrier group
*
*/
@POST
@Path("/v1/admin/group/{gid}/membership/remove")
@Consumes({ "application/json" })
@Produces({ "application/json" })
@Operation(summary = "Remove members from an Information Barrier group", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = BulkActionResult.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public BulkActionResult v1AdminGroupGidMembershipRemovePost(List body, @HeaderParam("sessionToken") String sessionToken, @PathParam("gid") String gid);
/**
* Get a list of all Information Barrier Groups
*
*/
@GET
@Path("/v1/admin/group/list")
@Produces({ "application/json" })
@Operation(summary = "Get a list of all Information Barrier Groups", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = GroupList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public GroupList v1AdminGroupListGet(@HeaderParam("sessionToken") String sessionToken);
/**
* Get all Information Policies
*
*/
@GET
@Path("/v1/admin/policy/list")
@Produces({ "application/json" })
@Operation(summary = "Get all Information Policies", tags={ })
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success", content = @Content(schema = @Schema(implementation = PolicyList.class))),
@ApiResponse(responseCode = "400", description = "Client error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "401", description = "Unauthorized: Session tokens invalid.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "403", description = "Forbidden: Caller lacks necessary entitlement.", content = @Content(schema = @Schema(implementation = Error.class))),
@ApiResponse(responseCode = "500", description = "Server error, see response body for further details.", content = @Content(schema = @Schema(implementation = Error.class))) })
public PolicyList v1AdminPolicyListGet(@HeaderParam("sessionToken") String sessionToken);
}