RemoteAuth

Authenticates the user and returns a URL to access the SuiteProjects Pro UI as the authenticated user.

Syntax

            <RemoteAuth> 
   <Login> 
      <company>example</company> 
      <user>mcollins</user> 
      <password>suiteprojectspro_password</password>
   </Login>
</RemoteAuth> 

          

Usage

Use the RemoteAuth command to authenticate the user and create an authenticated user session URL to access the SuiteProjects Pro UI in a browser.

Both Auth and RemoteAuth authenticate the user to perform other commands in the API call. However RemoteAuth returns a URL that can be used to access SuiteProjects Pro as the authenticated user in a browser without having to enter credentials on the SuiteProjects Pro sign-in page.

Note:

RemoteAuth should not be used as a substitute for Auth. RemoteAuth can be used to perform single sign-on and redirecting users to an active SuiteProjects Pro UI user session.

Arguments

Name	Type	Description
Login	Login	A Login object.

Response

A success or fail status. If successful, a URL to access the SuiteProjects Pro UI as the authenticated user.