Using an SSO Token

If you are using Single Sign-On for authentication, you can use the security check to submit the ticket.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]//j_spring_security_check?<arguments>

Argument

Type/Value

Description

ticket Text The ticket for your SSO mechanism. The default parameter name for an SSO authentication token is "ticket". This parameter name can be changed in the configuration file applicationContext-externalAuth-<sso>.xml.
Options  
accept: application/json  

Return Value on Success

Typical Return Values on Failure

302 Moved Temporarily – Response HTTP Header "Location" redirects to "/loginsuccess.html" by default, but often depends on the last session operation.

302 Moved Temporarily – Response HTTP Header "Location" redirects to /login.html?error=1.

For example, if you have configured the server to use CAS as your SSO provider, you can authenticate and receive the session ID with the following request:

GET http://localhost:8080/jasperserver-pro/j_spring_security_check?ticket=ST-40-CZeUUnGPxEqgScNbxh9l-sso-cas.eng.jaspersoft.com

The response has the same behavior as the password-based security check, including the use of a JSON file if requested.

Using a Pre-Authentication Token

When using a pre-authentication mechanism, the verification of the credentials is performed at the base URL of the server.

Method

URL

GET

http://<host>:<port>/jasperserver[-pro]/?<arguments>

Argument

Type/Value

Description

pp Text The token for your pre-authentication mechanism. The default parameter name for a pre authentication token is "pp". This parameter name can be changed in the configuration file applicationContext-externalAuth-preAuth.xml.
Options
accept: application/json

Return Value on Success

Typical Return Values on Failure

302 Moved Temporarily – Response HTTP Header "Location" redirects to "/loginsuccess.html" by default, but often depends on the last session operation.

302 Moved Temporarily – Response HTTP Header "Location" redirects to /login.html?error=1.

For example, if you have configured the server to use pre-authentication, you can authenticate and receive the session ID with the following request:

GET http://localhost:8080/jasperserver-pro?pp=u%3DSteve%7Cr%3DExt_User%7Co%3Dorganization_1%7Cpa1%3DUSA%7Cpa2%3D1
Version: 
Feedback