Package org.apereo.cas.support.rest.resources

Class ServiceTicketResource

  • @RestController("serviceTicketResourceRestController")
public class ServiceTicketResource
extends java.lang.Object
    RestController implementation of CAS' REST API.

    This class implements main CAS RESTful resource for vending/deleting TGTs and vending STs:

    • POST /v1/tickets
    • POST /v1/tickets/{TGT-id}
    • GET /v1/tickets/{TGT-id}
    • DELETE /v1/tickets/{TGT-id}
    Since:
    4.1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.springframework.http.ResponseEntity<java.lang.String> createServiceTicket​(javax.servlet.http.HttpServletRequest httpServletRequest, org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody, java.lang.String tgtId)
      Create new service ticket.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServiceTicketResource

        public ServiceTicketResource()

    • Method Detail

      • createServiceTicket

        @PostMapping(value="/v1/tickets/{tgtId:.+}",
             consumes="application/x-www-form-urlencoded")
public org.springframework.http.ResponseEntity<java.lang.String> createServiceTicket​(javax.servlet.http.HttpServletRequest httpServletRequest,
                                                                                     @RequestBody(required=false)
                                                                                     org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody,
                                                                                     @PathVariable("tgtId")
                                                                                     java.lang.String tgtId)
        Create new service ticket.
        Parameters:
        httpServletRequest - http request
        requestBody - request body
        tgtId - ticket granting ticket id URI path param
        Returns:
        ResponseEntity representing RESTful response