Log in with username and password

Your client application will be authorized to access CX Audience's REST APIs.

The very first REST API request must be to authenticate to a specific CX Audience account using a username and a password or certificates. Upon successful authentication, a token and an endpoint are returned in the response. You must use these authToken and endPoint values for any subsequent REST API request.

Important Note: For security reasons you must pass username and password as parameters in the POST request body only with the correct content type ('Content-Type': 'application/x-www-form-urlencoded'). Therefore, you must NOT use the URL string for passing in the authentication credentials.

  • Service URL: /rest/api/v1.3/auth/token
  • Request Method: POST
  • Request Header: Content-Type: application/x-www-form-urlencoded
  • Request Parameters: Send the following in the message body, x-www-form-urlencoded:
    
    user_name=<USER_NAME>
    password=<PASSWORD>
    auth_type=password
    		
  • Sample Request Body:
    
    user_name=johndoe
    password=oracleABC123*
    auth_type=password
    		
  • Response:
    
    {
    	"authToken" : <AUTH_TOKEN>,
    	"issuedAt" :  <TIMESTAMP> 
    }