Login Parameters for Custom Integrations

If you want to integrate CivilPro with a custom application we have some optional redirect parameters which can help for accessing records from login. The parameters are similar across login methods. In this article we show how to use them for both CivilPro Identity Logins via the Cloud App and how to use them for SAML authentication via our Cloud API.

Parameters for CivilPro Login

There are two parameters which can be used for logging into CivilPro

returnUrl

returnUrl is used when you know the exact record you wish to access or it can be used with the projectid parameter to access a particular register. This can be used to access any valid Url in the CivilPro App. 

To access a Record in the application the Url would be formatted as follows:

https://myComany.civilpro.com?returnUrl=lots/23

It could also be used to access a certain part of the application like:

https://myCompany.civilpro.com?returnUrl=account/explore

projectid

The projectid parameter should be used when a register is needed. Registers are not linked to a particular project so they need an extra projectid parameter to successfully login. 

To access a Register in the application the Url would be formatted as follows:

https://myCompany.civilpro.com?returnUrl=lots&projectid=1

Parameters for SAML Login

There are two parameters which can be used for logging into CivilPro with SAML authentication. They are similar to the two parameters explained above

redirect

redirect is used when you know the exact record you wish to access or it can be used with the projectid parameter to access a particular register. This can be used to access any valid Url in the CivilPro App. 

To access a Record in the application the Url would be formatted as follows:

https://myCompanydata.civilpro.com/api/auth/authsaml?redirect=lots/23 

It could also be used to access a certain part of the application like:

https://myCompanydata.civilpro.com/api/auth/authsaml?redirect=account/explore

projectid

The projectid parameter should be used when a register is needed. Registers are not linked to a particular project so they need an extra projectid parameter to successfully login. 

To access a Register in the application the Url would be formatted as follows:

https://myCompanydata.civilpro.com/api/auth/authsaml?redirect=lots&projectid=1