User API

/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": "",
    "thoughspotGroupsNotFound": ""
}

/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/createAuthToken

Creates an authentication token

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