Appearance
SAML Consumer
About 216 wordsLess than 1 minute
apiExtension PluginsAuthenticationSAML2
2025-03-13
MethodPOST
Request URL
/datafor/saml/consumer
Authorization
Use of this API requires authentication. For details about the authentication method, see
Authorization.
Content Typeapplication/x-www-form-urlencoded
Description
- This API is used as the SAML Assertion Consumer Service (ACS), responsible for processing SAML authentication responses.
- Configure this URL in the redirectUrl section of your SAML2 Identity Provider (IdP).
- After successful authentication via SAML2, the system redirects the user to the initial requested URL.
Params
Name | Location | Type | Required | Description |
---|---|---|---|---|
Cookie | header | string | Yes | Session cookie for authentication. |
Content-Type | header | string | Yes | Must be application/x-www-form-urlencoded . |
Request Example
SAMLResponse: PHNhbWxwXXXXXXXX==
ReadyState: f92cdfec-782c-XXXXXX-a33edbf88f67
Name | Location | Type | Required | Description |
---|---|---|---|---|
SAMLResponse | body | string | Yes | The Base64-encoded SAML response received from the IdP. |
ReadyState | body | string | No | A state token to maintain session tracking after authentication. |
Response Examples
✅ Success Response (200 OK)
{}
HTTP Responses
HTTP Status Code | Meaning | Description |
---|---|---|
200 | OK | SAML authentication processed successfully. |
400 | Bad Request | Invalid request or missing parameters. |
401 | Unauthorized | Authentication required. |
403 | Forbidden | User does not have permission. |
500 | Internal Server Error | Unexpected server error. |