Package com.alfresco.content.apis

Interface AuthenticationApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      abstract TicketEntry createTicket(@Body() TicketBody ticketBodyCreate) Create ticket (login) Note: this endpoint is available in Alfresco 5.2 and newer versions.
      abstract Unit deleteTicket() Delete ticket (logout) Note: this endpoint is available in Alfresco 5.2 and newer versions.
      abstract ValidTicketEntry validateTicket() Validate ticket Note: this endpoint is available in Alfresco 5.2 and newer versions.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • createTicket

        @Headers(value = {"Content-Type: application/json"})@POST(value = "authentication/versions/1/tickets") abstract TicketEntry createTicket(@Body() TicketBody ticketBodyCreate)

        Create ticket (login) Note: this endpoint is available in Alfresco 5.2 and newer versions. Logs in and returns the new authentication ticket. The userId and password properties are mandatory in the request body. For example: ``JSON { \"userId\": \"jbloggs\", \"password\": \"password\" } `` To use the ticket in future requests you should pass it in the request header. For example using Javascript: ``Javascript request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket)); `` The endpoint is owned by defaultname service owner @param ticketBodyCreate The user credential. (required)

      • deleteTicket

        @Headers(value = {"Content-Type: application/json"})@DELETE(value = "authentication/versions/1/tickets/-me-") abstract Unit deleteTicket()

        Delete ticket (logout) Note: this endpoint is available in Alfresco 5.2 and newer versions. Deletes logged in ticket (logout). The endpoint is owned by defaultname service owner

      • validateTicket

        @Headers(value = {"Content-Type: application/json"})@GET(value = "authentication/versions/1/tickets/-me-") abstract ValidTicketEntry validateTicket()

        Validate ticket Note: this endpoint is available in Alfresco 5.2 and newer versions. Validates the specified ticket (derived from Authorization header) is still valid. For example, you can pass the Authorization request header using Javascript: ``Javascript request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket)); `` The endpoint is owned by defaultname service owner