Principals API
Principals are users with access to the Marketing Cloud Personalization platform. The Personalization Principals API enables you to retrieve a full list of your Principals, which can help you adhere to various governance, risk, and compliance (GRC) guidelines.
GET /api/principals
https://<accountName>.<instance>.evergage.com/api/principals
URL Parameters
| URL Parameter | Required? | Description |
|---|---|---|
accountName | Yes | Your Personalization account name. You can retrieve it by accessing Gears from the Personalization UI and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/, then your account name is demo. |
instance | Yes | Your Personalization instance identifier. You can retrieve it by accessing Gears from the Personalization UI and reviewing the URL. For example, if your Gears URL is https://demo.us-1.evergage.com/, then your instance identifier is us-1. |
application/json
Authorization: Basic <base64-encoded-API-token>
The Principals API uses API tokens to authenticate requests. Your API token must be a strict Base64 encoding of your API Key ID and its API Secret Key, separated by a colon. You can use an existing API token if it has the required permissions or ask an account administrator to generate a new one from the Personalization UI by navigating to Security > API Tokens > Create Token. For more information on API tokens, see Personalization API Tokens on the Salesforce Help site.
Alternatively, if you use cURL to interact with the API, you can send your API Key ID and its API Key Secret using the -u "apiKeyId:apiKeySecret" command-line option. cURL automatically converts the apiKeyId:apiKeySecret pair into a Base64-encoded string and adds Authorization: Basic <base64-encoded-API-token> to the request header.
The following is an example API request sent using cURL.
The following is an example of a response to a valid GET request made to the Principals API endpoint.