GetSID API

Overview

The GetSID API lets you retrieve the Security Identifier (SID) of end users.

Because triggering a campaign via the Engage API requires the SID of the targeted users as a parameter, the GetSID API is specially useful for automatically triggering campaigns from environments where the SID of users is not readily available.

Calling the GetSID API

The Portal exposes the Engage API as a REST API under the URL:

https://[portal.company.com]/api/inventory/v1/getusersid

In the URL, substitute [portal.company.com] for the external DNS name of your Portal.

To get the SID of an end user, submit a POST request to the URL of the API (note that GET requests are not supported, returning a 404 error) with a JSON payload encoded in UTF-8 that contains two parameters:

Example of the JSON payload of a request to the API of Engage:

{
  "fieldName": "name",
  "fieldValues" : ["foobarUser@example.com"]
}

HTTP headers

Send your POST request to the GetSID API with the following HTTP headers to specify JSON content and basic authentication:

Content-type: application/json

Authorization: Basic [base-64(user:password)]

Replace [base-64(user:password)] with the credentials (in base-64 encoding) of a Nexthink user who has the right to access the API for triggering campaigns.

Error conditions

In response to a request, the Portal may send one of the following answers if something goes wrong:

RELATED TASK

• Triggering campaigns via their API