Auth

Authenticates the user.

Syntax

Password Authentication

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

OAuth 2.0 Access Token Authentication

              <Auth> 
   <Login> 
      <access_token>OAuth2_access_token</access_token>
   </Login>
</Auth>

In the example, OAuth2_access_token is the OAuth 2.0 access token obtained for the client application connecting to SuiteProjects Pro.

Usage

Use the Auth command to authenticate the user. The Auth XML command is required at the top of every XML API call for other commands to succeed.

The XML API supports the following authentication methods:

Password – User credentials (Company ID, User ID and Password) can be passed in the Auth command. See Password Authentication.
OAuth 2.0 access token – The access token (access_token) is passed instead of user credentials in the Auth XML command. See OAuth 2.0 Access Token Authentication.

For more information about OAuth 2.0, see OAuth 2.0 for Integration Applications Developers.

Important:

An invalid OAuth2 access token authorization has priority over a valid password or client session ID authentication. You cannot use password or client session ID authentication as a fallback for an invalid access token. See Using OAuth 2.0 Access Tokens in Your API Requests.

Arguments

Name	Type	Description
`Login`	`Login`	A `Login` object.

Name

Type

Description

Login

A Login object.

Response

A success or fail status. Success is required for other commands to complete successfully.