Skip to main content
POST
/
api
/
v1
/
external-sync
SyncOrganization
curl --request POST \
  --url https://your-sift-api-url.com/api/v1/external-sync \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "externalSync": {
    "organizationId": "<string>",
    "mostRecentSyncDate": "2023-11-07T05:31:56Z",
    "mostRecentSyncByUserId": "<string>",
    "scimServerUrl": "<string>",
    "tokenCreatedDate": "2023-11-07T05:31:56Z",
    "tokenLifetimeSeconds": 123,
    "mostRecentTokenByUserId": "<string>"
  },
  "existingUserCount": 123,
  "addedToOrganizationUserIds": [
    "<string>"
  ],
  "createdUsers": [
    {
      "userId": "<string>",
      "userName": "<string>",
      "organizations": [
        {
          "organizationId": "<string>",
          "organizationName": "<string>"
        }
      ]
    }
  ],
  "deactivatedUserIds": [
    "<string>"
  ],
  "existingGroupCount": 123,
  "createdUserGroups": [
    {
      "userGroupId": "<string>",
      "name": "<string>",
      "roleId": "<string>",
      "isDefault": true,
      "resources": {
        "assetIds": [
          "<string>"
        ],
        "allAssets": true
      },
      "userIds": [
        "<string>"
      ],
      "isExternal": true
    }
  ],
  "deletedUserGroupNames": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json · object

Response

A successful response.

externalSync
object
required
existingUserCount
integer
required
addedToOrganizationUserIds
string[]
required
createdUsers
object[]
required
deactivatedUserIds
string[]
required
existingGroupCount
integer
required
createdUserGroups
object[]
required
deletedUserGroupNames
string[]
required