Sitecore API catalog/OrderCloud/Impersonation configs

Impersonation configs

ImpersonationConfigs allow users to make API calls on behalf of a buyer user, which we refer to as impersonation. If you're a marketplace owner user with the BuyerImpersonation role you can impersonate any buyer user under your organization as long as an applicable Impersonation Config has been created. If you're a buyer user with the BuyerImpersonation role you can impersonate any other buyer user within the same buyer company as long as an applicable Impersonation Config has been created.

Operations

List impersonation configs

Request

Security
OAuth2(Required scopes: FullAccessSetSecurityProfile)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ImpersonationBuyerID""ImpersonationGroupID""ImpersonationUserID""BuyerID""GroupID""UserID""SecurityProfileID""ClientID""ID"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ImpersonationBuyerID""ImpersonationGroupID""ImpersonationUserID""BuyerID""GroupID""UserID""SecurityProfileID""ClientID""ID""!ImpersonationBuyerID"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/impersonationconfig?search=string&searchOn=ImpersonationBuyerID&sortBy=ImpersonationBuyerID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(ImpersonationConfig)
Example:
[
  {
    "ID": "",
    "ImpersonationBuyerID": "",
    "ImpersonationGroupID": "",
    "ImpersonationUserID": "",
    "BuyerID": "",
    "GroupID": "",
    "UserID": "",
    "SecurityProfileID": "",
    "ClientID": ""
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}