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

Class UserAuthenticationResource

  • @RestController("userAuthenticationResource")
public class UserAuthenticationResource
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> createTicketGrantingTicket​(org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody, javax.servlet.http.HttpServletRequest request)
      Create new ticket granting ticket.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UserAuthenticationResource

        public UserAuthenticationResource()

    • Method Detail

      • createTicketGrantingTicket

        @PostMapping(value="/v1/users",
             consumes="application/x-www-form-urlencoded")
public org.springframework.http.ResponseEntity<java.lang.String> createTicketGrantingTicket​(@RequestBody
                                                                                            org.springframework.util.MultiValueMap<java.lang.String,​java.lang.String> requestBody,
                                                                                            javax.servlet.http.HttpServletRequest request)
        Create new ticket granting ticket.
        Parameters:
        requestBody - username and password application/x-www-form-urlencoded values
        request - raw HttpServletRequest used to call this method
        Returns:
        ResponseEntity representing RESTful response