URL

https://<server>/unifiedconfig/config/wxci/sync

Operations

• POST: Manually trigger the Webex CI User Sync task.

REST Responses

Following are the possible REST responses that can be received for Webex CI User Sync API calls:

• Success (202 Accepted)

• User sync task already running (403 Forbidden)

• User sync task disabled (403 Forbidden)

Example of API 202 response headers:

• Location: https://<server>/unifiedconfig/config/asyncrequeststatus/db/<asyncTaskID>

Example of API 202 response body:

{
    "progress": "IN_QUEUE"
}

URL

https://<AW host>/unifiedconfig/config/wxci/sync/status

Operations

• GET: Access existing user sync configurations.

Sample Response

Success - 200 ok

When the periodic sync task is not scheduled, the API returns status as below:

{
    "currentSyncStatus": "NOT_SCHEDULED"
}

When the periodic sync task has executed, completed and updated the status in DB, the API returns status as below:

{
    "currentSyncStatus": "SCHEDULED",
    "lastSyncStats": "{5} users(s) created, {3} users updated, {1} user(s) failed",
    "lastSyncStatus": "SUCCESS",
    "lastSyncTime": "02:06, May 21, 2024"
}

Note	lastSyncTime is stored in UTC format in DB. API will convert this to AW timezone and return in the response.

Error Responses

Unauthorized - 400

Server errors - 500

URL

https://<server>/unifiedconfig/config/wxci/sync/config

Operations

• GET: Access existing Contact Center user sync configurations.

• PUT: Create and update Contact Center user sync configurations.

Parameters

• groups: A list of IDs for AD groups considered as source of users data.

• enabled: A boolean flag for enabling or disabling the auto sync feature.

• frequency: An integer value for specifying the frequency (in minutes) of auto sync feature.

Example create and update requests

{
    "enabled": true,
    "frequency": 1241,
    "groups": [
        {
            "group": [
                "groupID1",
                "groupID2",
                "groupID3"
            ]
        }
    ]
}

REST Responses

Following are the possible REST responses that can be received for Webex CI User Sync Config API calls:

• Success (200 OK)

Examples of API errors:

Error Response - Structural Errors

{
    "apiError": [
        {
            "errorData": "enabled",
            "errorMessage": "Invalid boolean value; must be true or false.",
            "errorType": "invalidInput.format.boolean"
        },
        {
            "errorData": "frequency",
            "errorMessage": "Not a number: number",
            "errorType": "invalidInput.unexpectedXmlElement"
        }
    ]
}

Error Response - Validation Errors

{
    "apiError": [
        {
            "errorMessage": "Size of group IDs list must be within the range 1 to 3.",
            "errorType": "wxci.syncConfig.groupsMax"
        },
        {
            "errorMessage": "Invalid sync group ID.",
            "errorType": "wxci.syncConfig.groupsInvalid"
        },
        {
            "errorMessage": "Invalid sync group ID.",
            "errorType": "wxci.syncConfig.groupsInvalid"
        },
        {
            "errorMessage": "Empty sync group ID is not allowed.",
            "errorType": "wxci.syncConfig.groupsEmptyValue"
        },
        {
            "errorMessage": "Duplicated group IDs.",
            "errorType": "wxci.syncConfig.groupsDuplicated"
        },
        {
            "errorMessage": "Frequency must be an integer within the range 30 to 1440.",
            "errorType": "wxci.syncConfig.frequencyMin"
        }
    ]
}