User API - Curator by InterWorks Documentation

/user/createBackendUser

Creates a backend user Returns: array

/user/createFrontendGroup

Creates a Frontend Group. Note: To add members to your Frontend Group, use the addUserToGroup API endpoint. Example Request: POST [your_domain]/api/v1/User/createFrontendGroup?apikey=[your_api_key_here]&name=[group_name_here]

    {
        "platforms": {
            "tableau":[
                {
                    "server":"tableau us", // Name of your Tableau Server Connection
                    "site":"__DEFAULT__",
                    "group":"Alligator Admins" // Display Name of your Tableau Server Group
                }
            ],
            "thoughtspot":[
                "Europe Sales" // Display Name of your ThoughSpot Group
            ]
        },
        "custom_attributes": {
            "color": "blue"
        }
    }

Returns: array Example Response:

    {
        "result": "Success",
        "msg": "Successfully added platform groups to frontend group 30 and added syncing to the queue",
        "metadata": [
            {
                "tableau_server": "tableau us|||https://tableau.your-domain.com",
                "tableau_site": "__DEFAULT__",
                "tableau_group": "Alligator Admins|||[tableau_group_id_here]"
            },
            {
                "thoughtspot_group": "Europe Sales|||[thoughtspot_group_id_here]"
            }
        ],
        "tableauGroupsNotFound": "",
        "thoughtspotGroupsNotFound": ""
    }

/user/fetchUser

Returns the currently logged in user’s information. Returns: array

/user/getManageablePermissions

Gets a listing of available manageable permissions Returns: array Example Response:

    {
        "status": "Success",
        "permissions": [
            "InterWorks.datamanager.data_structure",
            "InterWorks.datamanager.data",
            "InterWorks.tableauviz.access_tableau_settings",
            "InterWorks.tableauviz.access_dashboards",
            "InterWorks.integration.manage_scripts",
            "InterWorks.integration.run_scripts",
            "InterWorks.integration.manage_commands",
            "InterWorks.integration.run_commands",
            "InterWorks.integration.manage_api_relay",
            "InterWorks.usermgmt.manage_backend_users",
            "InterWorks.usermgmt.manage_frontend_users",
            "InterWorks.content.access_content",
            "InterWorks.portal.access_portal_settings",
            "InterWorks.portal.manage_upgrade",
            "InterWorks.portal.api_keys"
        ]
    }

/user/addUserToGroup

Adds a user to a group (syncs with Tableau if possible) Returns: array

/user/listGroups

Lists groups. Returns: array

/user/listUsers

Lists users and groups. Returns: array

/user/removeUserFromGroup

Removes a user from a group (syncs with Tableau if possible) Returns: array

/User/syncGroup

Kicks off a schedule which synchronizes a single Frontend Group’s membership. Specify the Group’s groupName OR the Group’s id (the id is used if both are provided). Parameters:

groupName (string, optional) - The name of the Frontend Group as shown on the backend under Settings > Users > Frontend Groups.
id (integer, optional) - The ID of the Frontend Group. One of groupName or id is required.

Example Request: GET [your_domain]/api/v1/User/syncGroup?apikey=[your_api_key_here]&groupName=[group_name_here] Returns: array Example Response:

    {
        "result": "Success",
        "msg": "[group_name_here] sync is queued."
    }

/User/syncGroups

Kicks off a schedule which synchronizes platform group memberships to all configured Frontend Groups. Internally this calls FrontendGroup::syncSchedule to enqueue a sync for every Frontend Group. Example Request: GET [your_domain]/api/v1/User/syncGroups?apikey=[your_api_key_here] Returns: array Example Response:

    {
        "result": "Success",
        "msg": "Group syncs are queued."
    }

Note: Both /User/syncGroup and /User/syncGroups enqueue jobs asynchronously - the API call returns as soon as the sync is queued. The actual membership sync runs through the queued process scheduler (curator:runschedule), so the work is not complete the moment the response is received.

​/user/createBackendUser

​/user/createFrontendGroup

​/user/fetchUser

​/user/getManageablePermissions

​/user/addUserToGroup

​/user/listGroups

​/user/listUsers

​/user/removeUserFromGroup

​/User/syncGroup

​/User/syncGroups