Overview

This document describes the endpoints available to the Consent Manager Reporting API. In addition to supported methods and parameters, sample code is also provided on how to pull data from TrustArc.

Environment

Consent Manager has an environment configured to host the release version of a product targeting end-users. This preferably does not change except for during scheduled releases.

  • Auth Server: https://login.truste.com
  • CCM Server: https://api.trustarc.com/api/ccm-reporting/

Token Access

In order to retrieve a token to be used in accessing APIs, you will need to use the token endpoint with grant_type=client_credentials of the Oauth2 specification. The endpoint is described below:

MethodPOST
URLhttps://login.truste.com/oauth/token
URL ParametersNameValueDescription
client_idStringThis refers to the client application credentials. Can also be added as a Basic Authorization header, where client_id is username and client_secret is password.
client_secretString
grant_typeStringThe Oauth2 grant_type method used. Value = ‘client_credentials’
Sample Success Response
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 21599,
  "scope": "openid profile email",
  "accountId": "bg4sea4f-b9c9-48e7-b13a-d3e7dd2cdf44",
  "firstName": "User",
  "lastName": "Name",
  "jobTitle": "LegalPrivacyCompliance",
  "userId": "9d2eec10-5137-4592-bdcc-5d31bfc3f0dd",
  "email": "user.name@example.com"
}
Success ResponseCode: 200
Sample Error Response
{
  "error": "unauthorized",
  "error_description": "Bad credentials"
}
Error Response

Code: 400 Bad Request 

Code: 401 Unauthorized