GetSID API（クラシック）

概要

_GetSID API_を使用することで、エンドユーザーのSecurity Identifier（SID）を取得できます。

Engage APIを通じてキャンペーンを起動するためには、ターゲットユーザーのSIDがパラメーターとして必要となるため、GetSID APIはユーザーのSIDがすぐには利用できない環境からキャンペーンを自動的に起動するために特に便利です。

GetSID APIの呼び出し

PortalはEngage APIをREST APIとして以下のURLで公開しています：

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

URLの[portal.company.com]を、あなたのPortalの外部DNS名に置き換えてください。

エンドユーザーのSIDを取得するには、UTF-8でエンコードされたJSONペイロードに2つのパラメーターを含めてAPIのURLにPOSTリクエストを送信してください（GETリクエストはサポートされず、404エラーが返ります）。

名前	説明
fieldName	ユーザーを取得するために使用されるフィールドの名前。 ユーザーを以下のどちらかで検索します： name: ユーザーのログオン名。 dn: Active Directoryのユーザーの識別名。
fieldValues	指定されたフィールドで検索する値のリスト（現在、1つの要素に制限）。

EngageのAPIへのリクエストのJSONペイロードの例：

{
 "fieldName": "name",
 "fieldValues" : ["[e-mail]"]
}

HTTPヘッダー

GetSID APIへのPOSTリクエストには、以下のHTTPヘッダーを使ってJSONコンテンツと基本認証を指定します。

Content-type: application/json

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

[base-64(user:password)]を、キャンペーンを起動するためにAPIにアクセスする権限を持つNexthinkユーザーの認証情報（base-64エンコード）に置き換えてください。

エラー条件

リクエストに対する応答として、何か問題が発生した場合、Portalは次のいずれかの回答を送信する場合があります：

エラータイプ	HTTPコード	原因
アクセス拒否	未承認 401	認証エラー
検証エラー	不正リクエスト 400	無効なJSON 無効なエンコーディング 無効なContent-type 不足または無効なfieldName 不足または多すぎるfieldValues
不明なエラー	内部サーバーエラー 500	未定義の内部エラー

---

関連タスク

• APIを通じてキャンペーンを起動する