メインコンテンツにスキップ
ドキュメント
ドキュメント
Adaptive Planning
最終更新: 2023-06-23
権限セット

権限セット

URL エンドポイント

https://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/users/permissionSets
バージョン: v1
カテゴリ
データの更新
説明
Adaptive Planning ユーザーに権限セットを割り当てます。
起動に必要な権限
管理アクセス
ユーザー
、
権限セット
権限セットの割当 API を使用すると、ユーザーの権限セットを取得および割り当てることができます。

サポートされている HTTPS VERB:

HTTP Verb
単一リソース
回収リソース
説明
GET
サポートされていません
サポート済
すべてのユーザーと、割り当てられた権限セットを取得します。
POST
サポート済
サポート済
ユーザーの権限セットを追加するか、既存の権限セットを更新します。

GET

リクエスト
/users/permissionSets
ユーザーに割り当てられた権限セットのコレクションを取得します
すべてのユーザーと、割り当てられた権限セットを取得します。instanceCode でフィルタできます。instanceCode クエリー パラメータが指定されていない場合、この API によりデフォルト インスタンス内のすべてのユーザーとその権限セットが取得されます。"limit" または "offset" のデフォルト値は、これらのクエリー パラメータが指定されていない場合に使用されます。
リクエスト URI の例:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/
クエリー パラメータ:
名前
説明
必須
instanceCode
インスタンス コンテキストを定義するインスタンスの一意の識別子。
なし
limit
単一の回答に含まれるオブジェクトの最大数デフォルト値は 500 です。最大値は 500 です。
なし
offset
回答一覧の最初のユーザーを示す 0 から始まるインデックス。デフォルトは 0 です。
limit パラメータで offset を使用して、回答一覧のページングを制御します。
なし
回答例
ユーザーが Workday と同期したインスタンスからの応答の例
 


  "links": {
      "next": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=10&limit=5",
      "previous": "https://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?offset=0&limit=5"
  },{
  "total": 34,
  "users": [
      {
    "userGuid": "111SampleUserGuid",
    "wid": "14400000000000000000000000000samplewid",
    "userName": "sampleuser1@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "112SampleUserGuid",
    "wid": "24400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 1,
        "name": "samplePermissionSet1"
      }
    ]
  },
      {
    "userGuid": "113SampleUserGuid",
    "wid": "34400000000000000000000000000samplewid",
    "userName": "sampleuser3@company.com",
    "permissionSet": [
      {
        "id": 2,
        "name": "samplePermissionSet2"
      }
    ]
  },
      {
    "userGuid": "114SampleUserGuid",
    "wid": "44400000000000000000000000000samplewid",
    "userName": "sampleuser4@company.com",
    "permissionSet": [
      {
        "id": 3,
        "name": "samplePermissionSet3"
      }
    ]
  },
      {
    "userGuid": "115SampleUserGuid",
    "wid": "54400000000000000000000000000samplewid",
    "userName": "sampleuser5@company.com",
    "permissionSet": [
      {
        "id": 4,
        "name": "samplePermissionSet4"
      }
    ]
  }
]
}

POST:

リクエスト:
/users/permissionSets:
ユーザーに権限セットを割り当てたり更新したりします。
ユーザーの権限セットを追加するか、既存の権限セットを更新します。instanceCode でフィルタできます。instanceCode クエリー パラメータが指定されていない場合、対応する権限セットがデフォルト インスタンス内のすべてのユーザーに割り当てられます。リクエスト本文で、次の必須クエリー フィールドを指定します: <userIdentifier> と permissionSet。対応する権限セットを複数のユーザーに割り当てる一括リクエストを送信するには、各権限の割当を含む配列を指定します。
クエリー パラメータ:
名前
説明
必須
instanceCode
インスタンス コンテキストを定義するインスタンスの一意の識別子。
なし
userIdentifier
Adaptive Planning の一意のユーザー ID を決定するユーザー ID。可能な値: userName、wid、userGuid。
あり
リクエストの例:
HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/users/permissionSets?userIdentifier=userName
リクエスト本文の例
POST リクエスト本文の例
 
[  
  {  
      "userName": "sampleuser1@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet1"
                  }
      ]
  },
  {
      "userName": "sampleuser2@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet2"
                  }
          ]
  },
  {
      "userName": "sampleuser3@company.com",
          "permissionSet": [
                  {
                      "name": "samplePermissionSet3"
                  }
          ]
  }
]
ペイロード パラメータ
名前
説明
必須
wid
ユーザーの Workday ID。
なし
userName
ユーザーのユーザー名 (ログイン名)。
なし
userGuid
作成時にシステムで割り当てられたグローバル一意ユーザー ID。
なし
名前
ID
権限セットの名前。
権限セットの ID。
権限セットの "名前" または "ID" のいずれかは必須です。
あり