ユーザー管理API

メソッド

ポスト

エンドポイント URL

https://<customer domain>/v1/users/services?notify=true/false

通知値を「true または false」として指定することにより、作成したユーザーにウェルカム メールを送信することを選択できます。

注意:

• 「通知」フラグが「true」に設定されている場合、ウェルカム メールがユーザーに送信されます。
• (デフォルト) 「通知」フラグの値が「false」の場合、ウェルカム メールはユーザーに送信されません。

重要: クエリ パラメータの通知値は、 true または false のいずれかです。

リクエスト本文のサンプル

{
"records": [
    {
        "FirstName": "Test",
        "LastName": "User",
        "Name":"Test User",
        "Email": "test@gs.com",
        "LicenseType":"Viewer",
        "SFDCUserName":"test9@gs.com",
        "CompanyName":"XYZ"
    },
    {
        "FirstName": "Test",
        "LastName": "User",
        "Name":"Test User",
        "Email": "test@gs.com",
        "LicenseType":"Viewer",
        "SFDCUserName":"test10@gs.com",
        "CompanyName":"XYZ"
    }
],
"lookups": {
    "CompanyID": {
        "fields": {
            "CompanyName": "Name"
        },
        "lookupField": "Gsid",
        "objectName": 「会社」、
        "multiMatchOption": "FIRSTMATCH",
        "onNoMatch":"ERROR"
    }
}
}

パラメータ

応答成功のサンプル

{
"result": true,
"errorCode": null,
"errorDesc": null,
"requestId": "c0d61647-d3ce-4785-8bfe-d6dacc5cdf88",
"data": {
    "status": "SUCCESS",
    "successRowCount": 2,
    "records": [
        {
            "IsSuperAdmin": false,
            "Email": "test@gs.com",
            "CompanyID": null,
            "Gsid": "1P01DX6HKU2QAQ2F3FBSO042UN34BJSUGWW1",
            "FirstName": "Test",
            "SFDCUserName": "test9@gs.com",
            "SystemType": "1I0054U9FAKXZ0H26HOLPCQ81MF6AUC6FF2X",
            "Name": "Test User",
            "LicenseType": "1I003CYFM4Q8T50O0EK4EPT0XX6S7SUXS5JJ",
            "IsActiveUser": true,
            "GainsightLicenseEnabled": false,
            "LastName": "User"
        },
        {
            "IsSuperAdmin": false,
            "Email": "test@gs.com",
            "CompanyID": null,
            "Gsid": "1P01DX6HKU2QAQ2F3FHQ0E6LOXYTGK8N7U10",
            "FirstName": "Test",
            "SFDCUserName": "test10@gs.com",
            "SystemType": "1I0054U9FAKXZ0H26HOLPCQ81MF6AUC6FF2X",
            "Name": "Test User",
            "LicenseType": "1I003CYFM4Q8T50O0EK4EPT0XX6S7SUXS5JJ",
            "IsActiveUser": true,
            "GainsightLicenseEnabled": false,
            "LastName": "User"
        }
    ],
    "errors": [],
    "success": true
},
"message": null
}

応答失敗のサンプル

{
"result": false,
"errorCode": "GU_2403",
"errorDesc": "Lookup objects [Company1] are not valid",
"requestId": "0bf61426-63ad-4774-ad95-4bd2f6c43c25",
"data": null,
"message": null
}

ユーザーの更新

このAPIを使用して、Gainsightでユーザーの詳細を更新することができます。以下は、このAPIを使用して更新できる、サポートされているユーザーフィールドになります。SFDCUserName, Gsid, SfdcUserId.

メソッド

PUT

エンドポイントのURL

https://<customer domain>/v1/users/services?key=[FieldName]

メモ：

• フィールド名は必須です。
• 一度に作成できるユーザー数は最大50人までです。

重要：クエリパラメータキーの値は、SFDCUserName/Gsid/SfdcUserIdのいずれかになります。キーの受け渡しは必須です。キーとして選択されたフィールドの値は、更新リクエストボディのユーザー記録で指定する必要があります。これらのフィールドを更新することはできません。

リクエスト本文のサンプル

{
"records": [
    {
        "IsActiveUser":true,
        "LicenseType": "Full",
        "SFDCUserName": "test3@gs.com",
        "CompanyName": "XYZ",
        "permissionBundles":["DEFAULT_BUNDLE"]
    },
    {
        "LicenseType":"Full",
        "SFDCUserName":"test2@gs.com",
        "permissionBundles":["DEFAULT_BUNDLE"]
        "CompanyName":"XYZ"
    }
],
"lookups": {
    "CompanyID": {
        "fields": {
            "CompanyName": "Name"
        },
        "lookupField": "Gsid",
        "objectName": 「会社」、
        "onNoMatch":"ERROR"
    }
},
         "permissionBundleAction":"overwrite"
}

PermissionBundleAction:

• permissionBundleActionオプションは既存のバンドルに追加するのか、既存のバンドルを上書きするのかを示します。
• デフォルトのアクションは「追加」です。
• サポートされているアクションは「追加/上書き」になります。

パラメータ

応答成功のサンプル

{
"result": true,
"errorCode": null,
"errorDesc": null,
"requestId": "5dd9296a-c5d3-4ae1-8fbb-56fd3a2e4d86",
"data": {
    "status": "SUCCESS",
    "successRowCount": 2,
    "records": [
        {
            "Email": "test3@gs.com",
            "CompanyID": null,
            "Gsid": "1P01DX6HKU2QAQ2F3F7JU49M384I1MDU66B9",
            "SystemType": "Internal",
            "Name": "Test User",
            "LicenseType": "Full",
            "IsActiveUser": true,
            "IsSuperAdmin": false,
            "FirstName": "Test",
            "SFDCUserName": "test3@gs.com",
            "GainsightLicenseEnabled": false,
            "LastName": "User"
        },
        {
            "Email": "test2@gs.com",
            "CompanyID": null,
            "Gsid": "1P01DX6HKU2QAQ2F3FKTBOET0641B3PBC2TO",
            "SystemType": "Internal",
            "Name": "Test User",
            "LicenseType": "Full",
            "IsActiveUser": true,
            "IsSuperAdmin": false,
            "FirstName": "Test",
            "SFDCUserName": "test2@gs.com",
            "GainsightLicenseEnabled": false,
            "LastName": "User"
        }
    ],
    "errors": [],
    "success": true
},
"message": null
}

応答失敗のサンプル

{
"result": false,
"errorCode": "GU_2403",
"errorDesc": "Lookup objects [Company1] are not valid",
"requestId": "0bf61426-63ad-4774-ad95-4bd2f6c43c25",
"data": null,
"message": null
}

ユーザーステータスの更新

このAPIを使用すると、Gainsightのユーザーステータス (アクティブ/非アクティブ) を更新することができます。

メソッド

PUT

エンドポイントのURL

https://<customer domain>/v1/users/services/status?status=true/false

メモ：一度に更新できるユーザーステータス数は最大50までです。

重要：クエリパラメータステータスは、trueまたはfalseです。

リクエスト本文のサンプル

リクエストボディーで、ユーザーGSIDを追加して、それぞれのユーザーを更新する必要があります。API呼び出しは無効なユーザーGSIDを無視します、そのため要求で有効なユーザー GSIDを指定したことを確認してください。

[
"1P01936XHTA4SF76ZU5RWZWIMDDL54UB7UF9",
"1P01936XHTA4SF76ZUUXHOUMVVSFH9YJM15A",
"1P01936XHTA4SF76ZUW5J2RVEZZ8H33C8MAM"
]

パラメータ

応答成功のサンプル

{
"result": true,
"errorCode": null,
"errorDesc": null,
"data": {
    "status": "COMPLETED"
},
"message": null
}

応答失敗のサンプル

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "localizedErrorDesc": null,
  "requestId": "5c1d2242-8c71-4c1c-84e3-8f6e9187c650",
  "data": {
      "invalidUserIds": [
          "1P01936XHTA4SF76ZUW5J2RVEZZ8H33C8MAM",
          "1P01936XHTA4SF76ZU5RWZWIMDDL54UB7UF9",
          "1P01936XHTA4SF76ZUUXHOUMVVSFH9YJM15A"
      ]
  },
  "message": null,
  "localizedMessage": null
}

ユーザーの詳細を取得

このAPIを使用すると、Gainsightのユーザー詳細を取得することができます。属性を指定して、API応答でユーザーの詳細を表示することができます。

メソッド

ポスト

エンドポイントのURL

https://<customer domain>/v1/users/services/list

リクエスト本文のサンプル

{




"includeTotal": true,
"limit": 25,
"page": 0,
"orderBy": {
    "ModifiedDate": "desc"
},
"select": [
    "Name",
    "SFDCUserName",
    "Email",
    "IsSuperAdmin",
    "ModifiedDate",
    "LicenseType"
],
"where": {
    "conditions": [
        {
            "name": "SystemType",
            "alias": "SystemTypeNotIn",
            "value": [
                "1I0054U9FAKXZ0H26H8LWSP9IXL2NBBNBAGG",
                "1I00BVVU4MEPNLT5UUTEI7IOVQ51BTETMIYR"
            ],
            "operator": "NOT_IN"
        },
        {
            "alias": "A",
            "name": "SystemType",
            "operator": "IN",
            「value": [
                "1I0054U9FAKXZ0H26HIODPYB6VXM69JDPA5O",
                "1I0054U9FAKXZ0H26HR1I0W4KFTTAGJ8UIUH"
            ]
        }
    ],
    "expression": "SystemTypeNotIn AND (A)"
}
}

パラメータ

応答成功のサンプル

{
"result": true,
"errorCode": null,
"errorDesc": null,
"requestId": "873207cc-f7fb-47df-9034-de4797a94ad5",
"data": {
    "page": 0,
    "size": 5,
    "total": 5,
    "limit": 25,
    "users": [
        {
            "IsSuperAdmin": false,
            "Email": "test3@gs.com",
            "Gsid": "1P0186EIDXGJI1O93WM1ZK3A19R6ORXFQTFY",
            "SFDCUserName": "test3@gs.com",
            "ModifiedDate": "2021-12-01T11:13:47Z",
            "ProfilePicture": null,
            "Name": "Test User",
            "LicenseType": "Full",
            "Status": "Active"
        }
    ]
},
"message": null
}

応答失敗のサンプル

{
"result": false,
"errorCode": "GU_1705",
"errorDesc": "Invalid select fields",
"requestId": "981cdb70-675e-4052-b7a1-9521526892ca",
"data": null,
"message": null
}