Class ScopesResource


  • @Path("/scopes")
    @Produces("application/json")
    @Consumes("application/json")
    public class ScopesResource
    extends ConfigBaseResource
    Configures both OpenID Connect and UMA scopes.
    Author:
    Mougang T.Gasmyr
    • Field Summary

      • Fields inherited from class io.jans.configapi.core.rest.BaseResource

        FIELD_VALUE_SEPARATOR, MISSING_ATTRIBUTE_CODE, MISSING_ATTRIBUTE_MESSAGE, TOKEN_DELIMITER
    • Constructor Summary

      Constructors 
      Constructor Description
      ScopesResource()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      jakarta.ws.rs.core.Response createOpenidScope​(@Valid io.jans.as.persistence.model.Scope scope)  
      jakarta.ws.rs.core.Response deleteScope​(@NotNull String inum)  
      jakarta.ws.rs.core.Response getScopeByClientId​(@NotNull String creatorId)  
      jakarta.ws.rs.core.Response getScopeById​(@NotNull String inum, boolean withAssociatedClients)  
      jakarta.ws.rs.core.Response getScopeByType​(@NotNull String type)  
      jakarta.ws.rs.core.Response getScopes​(String type, int limit, String pattern, int startIndex, String sortBy, String sortOrder, boolean withAssociatedClients, String fieldValuePair)  
      jakarta.ws.rs.core.Response patchScope​(@NotNull String inum, @NotNull String pathString)  
      jakarta.ws.rs.core.Response updateScope​(@Valid io.jans.as.persistence.model.Scope scope)  
      • Methods inherited from class io.jans.configapi.core.rest.BaseResource

        checkNotEmpty, checkNotEmpty, checkNotNull, checkNotNull, checkNotNull, checkResourceNotNull, createSearchRequest, findRootError, getBadRequestException, getBadRequestException, getBadRequestException, getHttpHeaders, getHttpRequest, getInternalServerException, getMissingAttributeError, getNotAcceptableException, getNotFoundError, getUriInfo, throwBadRequestException, throwBadRequestException, throwBadRequestException, throwInternalServerException, throwInternalServerException, throwMissingAttributeError
    • Constructor Detail

      • ScopesResource

        public ScopesResource()
    • Method Detail

      • getScopes

        @GET
        public jakarta.ws.rs.core.Response getScopes​(@DefaultValue("") @QueryParam("type")
                                                     String type,
                                                     @DefaultValue("50") @QueryParam("limit")
                                                     int limit,
                                                     @DefaultValue("") @QueryParam("pattern")
                                                     String pattern,
                                                     @DefaultValue("0") @QueryParam("startIndex")
                                                     int startIndex,
                                                     @DefaultValue("inum") @QueryParam("sortBy")
                                                     String sortBy,
                                                     @DefaultValue("ascending") @QueryParam("sortOrder")
                                                     String sortOrder,
                                                     @DefaultValue("false") @QueryParam("withAssociatedClients")
                                                     boolean withAssociatedClients,
                                                     @DefaultValue("") @QueryParam("fieldValuePair")
                                                     String fieldValuePair)
      • getScopeById

        @GET
        @Path("{inum}")
        public jakarta.ws.rs.core.Response getScopeById​(@NotNull @PathParam("inum")
                                                        @NotNull String inum,
                                                        @DefaultValue("false") @QueryParam("withAssociatedClients")
                                                        boolean withAssociatedClients)
      • getScopeByClientId

        @GET
        @Path("creator/{creatorId}")
        public jakarta.ws.rs.core.Response getScopeByClientId​(@NotNull @PathParam("creatorId")
                                                              @NotNull String creatorId)
      • getScopeByType

        @GET
        @Path("type/{type}")
        public jakarta.ws.rs.core.Response getScopeByType​(@NotNull @PathParam("type")
                                                          @NotNull String type)
      • createOpenidScope

        @POST
        public jakarta.ws.rs.core.Response createOpenidScope​(@Valid
                                                             @Valid io.jans.as.persistence.model.Scope scope)
      • updateScope

        @PUT
        public jakarta.ws.rs.core.Response updateScope​(@Valid
                                                       @Valid io.jans.as.persistence.model.Scope scope)
      • patchScope

        @PATCH
        @Consumes("application/json-patch+json")
        @Path("{inum}")
        public jakarta.ws.rs.core.Response patchScope​(@PathParam("inum") @NotNull
                                                      @NotNull String inum,
                                                      @NotNull
                                                      @NotNull String pathString)
                                               throws com.github.fge.jsonpatch.JsonPatchException,
                                                      IOException
        Throws:
        com.github.fge.jsonpatch.JsonPatchException
        IOException
      • deleteScope

        @DELETE
        @Path("{inum}")
        public jakarta.ws.rs.core.Response deleteScope​(@PathParam("inum") @NotNull
                                                       @NotNull String inum)