Package org.graylog.security.authservice.rest

Class AuthServiceBackendsResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog.security.authservice.rest.AuthServiceBackendsResource

@Path("/system/authentication/services/backends")
@Consumes("application/json")
@Produces("application/json")
@RequiresAuthentication
public class AuthServiceBackendsResource
extends RestResource

Field Summary

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

configuration

Constructor Summary

Constructors

Constructor	Description
AuthServiceBackendsResource(DBAuthServiceBackendService dbService, GlobalAuthServiceConfig globalAuthServiceConfig, PaginatedUserService userService, RoleService roleService, AuthServiceBackendUsageCheck usageCheck)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	create(@NotNull AuthServiceBackendDTO newConfig)
void	delete(@NotBlank String backendId)
javax.ws.rs.core.Response	get(@NotBlank String backendId)
javax.ws.rs.core.Response	getActiveType()
PaginatedResponse<UserOverviewDTO>	getUsers(int page, int perPage, String query, String sort, String order, @NotBlank String backendId)
PaginatedResponse<AuthServiceBackendDTO>	list(PaginationParameters paginationParameters)
javax.ws.rs.core.Response	update(@NotBlank String backendId, @NotNull AuthServiceBackendDTO updatedConfig)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, setPrettyPrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AuthServiceBackendsResource

@Inject
public AuthServiceBackendsResource(DBAuthServiceBackendService dbService,
 GlobalAuthServiceConfig globalAuthServiceConfig,
 PaginatedUserService userService,
 RoleService roleService,
 AuthServiceBackendUsageCheck usageCheck)

Method Details

getActiveType

@GET
@RequiresGuest
@Path("active-backend/type")
public javax.ws.rs.core.Response getActiveType()

list

@GET
public PaginatedResponse<AuthServiceBackendDTO> list(@BeanParam
 PaginationParameters paginationParameters)

get

@GET
@Path("{backendId}")
public javax.ws.rs.core.Response get(@PathParam("backendId") @NotBlank
 @NotBlank String backendId)

create

@POST
@RequiresPermissions("authservicebackend:create")
public javax.ws.rs.core.Response create(@NotNull
 @NotNull AuthServiceBackendDTO newConfig)

update

@PUT
@Path("{backendId}")
public javax.ws.rs.core.Response update(@PathParam("backendId") @NotBlank
 @NotBlank String backendId,
 @NotNull
 @NotNull AuthServiceBackendDTO updatedConfig)

delete

@DELETE
@Path("{backendId}")
public void delete(@PathParam("backendId") @NotBlank
 @NotBlank String backendId)

getUsers

@GET
@Path("{backendId}/users")
@RequiresPermissions({"authserviceglobalconfig:read","users:read"})
public PaginatedResponse<UserOverviewDTO> getUsers(@QueryParam("page") @DefaultValue("1")
 int page,
 @QueryParam("per_page") @DefaultValue("50")
 int perPage,
 @QueryParam("query") @DefaultValue("")
 String query,
 @DefaultValue("full_name") @QueryParam("sort")
 String sort,
 @DefaultValue("asc") @QueryParam("order")
 String order,
 @PathParam("backendId") @NotBlank
 @NotBlank String backendId)