GET Preferences

Returns the caller's user preferences.

Requirements

Permissions: The caller is not required to have any special permissions.
Token scope: Any valid scope, such as Agent, Certificate, or SSH

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

To get all of the caller's preferences, make this call without any parameters. Otherwise, pass one or more of the following parameters:

Input parameters
Name	Description
Category	(Optional) The global or custom preference category. For example, Dashboard.
Name	(Optional) The preference name.
Product	(Optional) A Venafi product: CodeSign Protect Client Protect Platform SSH Protect TLS Protect

Returns

For an invalid request, GET Preferences returns a HTTP 400 Bad Request. Otherwise, this API call returns a HTTP 200 OK and the following data:

Response description
Name	Description
Preferences	An array of custom settings that apply to the caller. If there are no custom settings, the Preferences array is empty. Id: The preference Identifier. Universal: The Universal Unique Identifier (UUID) of the caller. Product: Null or a Venafi product name. Category: Either null or a UI category. For example, Dashboard, UI, or a custom category. Name: The preference name. Value: The preference value. Locked: True: A global preference that does not allow changes. or False: A suggested global or custom setting that allows updates.

Example List all of the caller's preferences that appear on dashboards

Request for Example

GET https://tpp.venafi.example/vedsdk/Preferences?Category=Dashboard
Authorization:Bearer 4MyGeneratedBearerTknz==

Response for Example

HTTP/1.1 200 OK
{
   "Preferences":[
      {
         "Id":275,
         "Universal":"local:{38bf2548-3677-4cf3-97f4-9f7a20b8f55b}",
         "Product":null,
         "Category":"Dashboard",
         "Name":"defaultDashboard",
         "Value":"certificate-dashboard",
         "Locked":false
      }
   ]
}