Verifying Tickets (CAS 3.0)

Function

This API is used by an application to verify tickets and obtain user attributes.

Constraints

null

URI

GET /api/v1/cas/p3/serviceValidate

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
service	Yes	String	URL for an application to receive tickets. The URL must be the same as the application callback URL in the CAS configuration.
ticket	Yes	String	Service ticket obtained during login authentication.
format	No	String	Format of user information in the response. Options: XML and JSON.

Request Parameters

None

Response Parameters

None

Example Requests

Call the CAS 3.0 API to verify a ticket. Obtain the user attribute information in the JSON response format by configuring parameters, including the application callback address (https://example.com), and authentication ticket (ST-eYlKs8FrLCltwRwfm8AiwCxmQ8gAL...) obtained by the login authentication API.

GET https://{domain_name}/api/v1/cas/p3/serviceValidate?service=https://example.com&ticket=ST-eYlKs8FrLCltwRwfm8AiwCxmQ8gAL...&format=JSON

Example Responses

Status code: 200

Request successful.

Example 1

<cas:serviceResponse xmlns:cas="http://www.yale.edu/tp/cas">
    <cas:authenticationSuccess>
        <cas:user>minghui</cas:user>
        <cas:attributes>
            <cas:authenticationDate>2020-02-11T09:28:14.987Z</cas:authenticationDate>
            <cas:longTermAuthenticationRequestTokenUsed>false</cas:longTermAuthenticationRequestTokenUsed>
            <cas:isFromNewLogin>true</cas:isFromNewLogin>
            <cas:date>2020-02-03T16:00:00.000Z</cas:date>
            <cas:birthday>2020-02-04T16:00:00.000Z</cas:birthday>
            <cas:createAt>2020-01-10T09:01:04.000Z</cas:createAt>
            <cas:disabledAt>null</cas:disabledAt>
            <cas:disabed>false</cas:disabed>
        </cas:attributes>
    </cas:authenticationSuccess>
</cas:serviceResponse>

Example 2

{
  "serviceResponse" : {
    "authenticationSuccess" : {
      "attributes" : {
        "date" : "2020-02-03T16:00:00.000Z",
        "birthday" : "2020-02-04T16:00:00.000Z",
        "createAt" : "2020-01-10T09:01:04.000Z",
        "disabed" : false,
        "authenticationDate" : "2020-02-11T06:43:30.588Z",
        "longTermAuthenticationRequestTokenUsed" : false,
        "isFromNewLogin" : true
      },
      "user" : "minghui"
    }
  }
}