SyncOrganization

POST

/api/v1/external-sync

Request Body

application/jsonRequired

`body`
Required
object

curl -X POST "<API_URL>/api/v1/external-sync" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

A successful response.

{
  "externalSync": {
    "organizationId": "string",
    "mostRecentSyncDate": "2019-08-24T14:15:22Z",
    "mostRecentSyncByUserId": "string",
    "scimServerUrl": "string",
    "tokenCreatedDate": "2019-08-24T14:15:22Z",
    "tokenLifetimeSeconds": 0,
    "mostRecentTokenByUserId": "string"
  },
  "existingUserCount": 0,
  "addedToOrganizationUserIds": [
    "string"
  ],
  "createdUsers": [
    {
      "userId": "string",
      "userName": "string",
      "organizations": [
        {
          "organizationId": "string",
          "organizationName": "string"
        }
      ]
    }
  ],
  "deactivatedUserIds": [
    "string"
  ],
  "existingGroupCount": 0,
  "createdUserGroups": [
    {
      "userGroupId": "string",
      "name": "string",
      "roleId": "string",
      "isDefault": true,
      "resources": {
        "assetIds": [
          "string"
        ],
        "allAssets": true
      },
      "userIds": [
        "string"
      ],
      "isExternal": true
    }
  ],
  "deletedUserGroupNames": [
    "string"
  ]
}

Request Body

bodyRequiredobject

Response

`body`
Required
object