Get Telemetry Agreement

Get Telemetry Agreement

Determine if telemetry agreement has been displayed. If false, the agreement text will be displayed at login time.

Request
URI
GET
https://{api_host}/ssp/telemetry/agreement
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns TelemetryAgreement of type(s) application/json
This response body class contains all of the following: InlineTelemetryAgreement2
{
    "_self": {},
    "_links": [
        {
            "href": "string",
            "action": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_revision": 0,
    "resource_type": "string",
    "_create_user": "string",
    "_create_time": 0,
    "_last_modified_user": "string",
    "_last_modified_time": 0,
    "_system_owned": false,
    "_protection": "string",
    "id": "string",
    "display_name": "string",
    "description": "string",
    "path": "string",
    "relative_path": "string",
    "parent_path": "string",
    "ceip_acceptance": false,
    "telemetry_agreement_displayed": false
}

204

No content

Operation doesn't return any data structure

default

4XX and 5XX type errors with appropriate message

Returns Error of type(s) application/json
"Error Object"
integer
error_code
Required

HTTP Status or Application error code

string
module_name
Optional

Module where the error happened

string
error_message
Required

Message describing the error


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/ssp/telemetry/agreement