POST api/Import/SyncRequestorUsers

Bulk create/update users. Max bulk size is 100 users. Optional parameters are cleared to its default when not provided on update.

Request Information

URI Parameters

None.

Body Parameters

List of objects

Collection of RequestorUserImportPost

Name	Type	Additional information
UserProviderKey	string	None.
ExternalId	string	None.
Email	string	None.
Operations	Collection of JsonPatchOperation	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "UserProviderKey": "sample string 1",
    "ExternalId": "sample string 2",
    "Email": "sample string 3",
    "Operations": [
      {
        "Operation": 0,
        "FromPath": "sample string 1",
        "ParsedFromPath": null,
        "Path": "sample string 2",
        "ParsedPath": null,
        "Value": {}
      },
      {
        "Operation": 0,
        "FromPath": "sample string 1",
        "ParsedFromPath": null,
        "Path": "sample string 2",
        "ParsedPath": null,
        "Value": {}
      }
    ]
  },
  {
    "UserProviderKey": "sample string 1",
    "ExternalId": "sample string 2",
    "Email": "sample string 3",
    "Operations": [
      {
        "Operation": 0,
        "FromPath": "sample string 1",
        "ParsedFromPath": null,
        "Path": "sample string 2",
        "ParsedPath": null,
        "Value": {}
      },
      {
        "Operation": 0,
        "FromPath": "sample string 1",
        "ParsedFromPath": null,
        "Path": "sample string 2",
        "ParsedPath": null,
        "Value": {}
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfRequestorUserImportPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts.Import">
  <RequestorUserImportPost>
    <Operations xmlns:d3p1="http://schemas.datacontract.org/2004/07/JsonPatch" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
      <d3p1:JsonPatchOperation>
        <d3p1:FromPath>sample string 1</d3p1:FromPath>
        <d3p1:Operation>add</d3p1:Operation>
        <d3p1:ParsedFromPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:ParsedPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:Path>sample string 2</d3p1:Path>
        <d3p1:Value />
      </d3p1:JsonPatchOperation>
      <d3p1:JsonPatchOperation>
        <d3p1:FromPath>sample string 1</d3p1:FromPath>
        <d3p1:Operation>add</d3p1:Operation>
        <d3p1:ParsedFromPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:ParsedPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:Path>sample string 2</d3p1:Path>
        <d3p1:Value />
      </d3p1:JsonPatchOperation>
    </Operations>
    <Email>sample string 3</Email>
    <ExternalId>sample string 2</ExternalId>
    <UserProviderKey>sample string 1</UserProviderKey>
  </RequestorUserImportPost>
  <RequestorUserImportPost>
    <Operations xmlns:d3p1="http://schemas.datacontract.org/2004/07/JsonPatch" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
      <d3p1:JsonPatchOperation>
        <d3p1:FromPath>sample string 1</d3p1:FromPath>
        <d3p1:Operation>add</d3p1:Operation>
        <d3p1:ParsedFromPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:ParsedPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:Path>sample string 2</d3p1:Path>
        <d3p1:Value />
      </d3p1:JsonPatchOperation>
      <d3p1:JsonPatchOperation>
        <d3p1:FromPath>sample string 1</d3p1:FromPath>
        <d3p1:Operation>add</d3p1:Operation>
        <d3p1:ParsedFromPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:ParsedPath xmlns:d5p1="http://schemas.datacontract.org/2004/07/JsonPatch.Paths.Components" i:nil="true" />
        <d3p1:Path>sample string 2</d3p1:Path>
        <d3p1:Value />
      </d3p1:JsonPatchOperation>
    </Operations>
    <Email>sample string 3</Email>
    <ExternalId>sample string 2</ExternalId>
    <UserProviderKey>sample string 1</UserProviderKey>
  </RequestorUserImportPost>
</ArrayOfRequestorUserImportPost>

Response Information

Resource Description

Returns HttpStatusCode 200 OK if the sync has been executed successfully, along with a list of created or updated results. The result contains all records for each user, including detailed information about the synchronization operation. It primarily includes Success and ErrorMessage values for each user. If the input is invalid, returns 400 BadRequest with a message.

SyncRequestorUsersResult

Name	Description	Type	Additional information
RequestorUsers	List of SyncRequestorUserResult	Collection of SyncRequestorUserResult	None.

Response Formats

application/json, text/json

Sample:

{
  "RequestorUsers": [
    {
      "Username": "JohnDoe",
      "Success": true,
      "ErrorMessage": null,
      "UserProviderKey": "3aa87a2d-c4ab-425e-8859-4cfcb7eb44b7",
      "UserProviderKeyConflict": null,
      "CustomerId": 121,
      "ExternalId": null
    }
  ]
}

application/xml, text/xml

Sample:

<SyncRequestorUsersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <RequestorUsers>
    <SyncRequestorUserResult>
      <CustomerId>121</CustomerId>
      <ErrorMessage i:nil="true" />
      <ExternalId i:nil="true" />
      <Success>true</Success>
      <UserProviderKey>3aa87a2d-c4ab-425e-8859-4cfcb7eb44b7</UserProviderKey>
      <UserProviderKeyConflict i:nil="true" />
      <Username>JohnDoe</Username>
    </SyncRequestorUserResult>
  </RequestorUsers>
</SyncRequestorUsersResult>