サポート (英語のみ)

GetSID API (クラシック)

概要

GetSID API は、エンドユーザーのセキュリティ識別子 (SID) を取得することができます。

Engage APIを介してキャンペーンをトリガーする には、ターゲットユーザーのSIDをパラメータとして指定する必要があるため、GetSID APIはユーザーのSIDがすぐに入手できない環境からキャンペーンを自動的にトリガーするのに特に役立ちます。

GetSID APIの呼び出し

ポータルは、Engage APIを次のURLでREST APIとして公開しています:

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

URLでは、[portal.company.com]をポータルの外部DNS名で置き換えます。

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

名前
説明

fieldName

ユーザーを取得するためのフィールドの名前。 ユーザーを以下のいずれかで検索します:

  • name: ユーザーログオン名。

  • dn: Active Directoryのユーザー識別名。

fieldValues

指定したフィールドで検索する値のリスト（現在は1要素に制限されています）。

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

{
 "fieldName": "name",
 "fieldValues" : ["[email protected]"]
}

HTTP ヘッダ

GetSID APIにPOSTリクエストを送信する際、JSONコンテンツと基本認証を指定するために以下のHTTPヘッダを送信してください:

Content-type: application/json

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

[base-64(user:password)]を、キャンペーンをトリガーするAPIへのアクセス権限を持つNexthinkユーザーの資格情報（base-64エンコード）に置き換えます。

エラー条件

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

エラータイプ
HTTPコード
原因

アクセス拒否

未認証 401

  • 認証エラー

検証エラー

不正なリクエスト 400

  • 無効なJSON

  • 無効なエンコーディング

  • 無効なContent-type

  • 欠如または無効なfieldName

  • 欠如または過剰なfieldValues

不明なエラー

内部サーバーエラー 500

  • 未定義の内部エラー

関連タスク

Last updated

Was this helpful?