POST Preferences
Adds new user preferences for the caller. The preference you create only applies to the caller.
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 list these values, call GET Preferences.
Name |
Description |
---|---|
Preferences |
An array of custom settings that apply to the caller:
|
Returns
For an invalid request, POST Preferences returns a HTTP 400 BadRequest. Otherwise, this API call returns a HTTP 201 Created.
Example: Add a widget to the SSH Dashboard
Request for Example
POST https://tpp.venafi.example/vedsdk/Preferences
Authorization:Bearer 4MyGeneratedBearerTknz==
{ "Preferences":[ { "Product":"SSH Protect", "Category":"Dashboard", "Name":"ssh-dashboard", "Value":"{\"index\":6,\"widgetTypeId\":\"ssh-discovery-summary\"}" } ] }
Response for Example
HTTP/1.1 201 Created { }