GET /config/disclaimer

On this page:

Retrieve the current disclaimer text, as specified by POST /command/config/set-disclaimer. This endpoint does not retrieve the contents of any disclaimer.txt file.

Request format

You must have the configuration:view_disclaimer permission to use this endpoint.

When Forming RBAC API requests to this endpoint, the request is a basic call with authentication, such as:

curl "https://$(puppet config print server):4433/rbac-api/v1/config/disclaimer" -H "X-Authentication: $(puppet access show)"

Response format

If POST /command/config/set-disclaimer was previously used to specify disclaimer text, a well-formed request returns 200 OK and the disclaimer text, such as:

{
  "disclaimer": "Not to be accessed by unauthorized users"
}

The endpoint return 404 Not Found if:

You haven't specified disclaimer text with POST /command/config/set-disclaimer.
Previously-specified text was removed with POST /command/config/remove-disclaimer.
You've only used a disclaimer.txt file to Create a custom login disclaimer. The GET /config/disclaimer endpoint doesn't check for the existence of a disclaimer.txt file, and it doesn't return the contents of such a file.

If you lack permission to retrieve the disclaimer text, the response is 403 Not Permitted.

For other error responses, refer to RBAC service errors .