Updated on 2024-12-30 GMT+08:00

Logging In

Function

When a user accesses an integrated application, the application sends a CAS-based login request (redirection mode) to OneAccess. The user adds an authorized account for the application and transfers parameters username and password using the application authentication login API POST/api/v1/login/form. The user enters their username and password to complete the authentication, and then calls the following API. OneAccess redirects the user to the application, with the ticket parameter transferring the service ticket.

Constraints

null

URI

GET /api/v1/cas/login

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.

Request Parameters

None

Response Parameters

Status code: 302

Table 2 Response header parameters

Parameter

Type

Description

Location

String

Redirection address used after successful authentication. Example: https://example.com?ticket=ST-eYlKs8FrLCltwRwfm8AiwCxmQ8gAL...

Example Requests

Call the CAS single sign-on (SSO) API for authentication. Set the redirection address carrying ticket information to https://example.com.

GET https://{domain_name}/api/v1/cas/login?service=https://example.com

Example Responses

None

Status Codes

Status Code

Description

302

The login is successful or the user has already logged in. The user is redirected to the service address (for example, https://example.com?ticket=ST-eYlKs8FrLCltwRwfm8AiwCxmQ8gALNSK) with a service ticket.

Error Codes

See Error Codes.