Help Center/ OneAccess/ API Reference/ OneAccess APIs/ Application Integration APIs/ SAML 2.0 Authentication/ Logging In Through IdP-Initiated SSO
Updated on 2024-12-30 GMT+08:00
View PDF
Share

Logging In Through IdP-Initiated SSO

Function

This API is used to initiate SSO login through an IdP.

Constraints

null

URI

GET /api/v1/saml2/idp/sso

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

sp

Yes

String

Application entity ID.

Request Parameters

None

Response Parameters

None

Example Requests

Initiate SSO login through an IdP. The entity ID is https://example.com/sp/.

https://{domain_name}/api/v1/saml2/idp/sso?sp=https://example.com/sp/

Example Responses

None

Status Codes

Status Code

Description

200

The login is successful, and an assertion is sent to the SP's assertion consumption address.

302

The login fails, and the user is redirected to the login address.

Error Codes

See Error Codes.

Parent topic: SAML 2.0 Authentication