Skip to main content
New to Corsair? See API access, authentication, and error handling.

Clients

createClient

clients.createClient Create Client on Klipfolio Risk: write
Input Output

createClientSettings

clients.createClientSettings Set Client Settings on Klipfolio Risk: write
Input Output

deleteClient

clients.deleteClient Delete Client on Klipfolio Risk: destructive
Input Output

deleteClientProperties

clients.deleteClientProperties Delete Client Property on Klipfolio Risk: destructive
Input Output

deleteClientShareRight

clients.deleteClientShareRight Revoke Group Access to Client on Klipfolio Risk: destructive
Input Output

enableDirectBillingClient

clients.enableDirectBillingClient Switch a client to direct billing on Klipfolio (cannot be undone) Risk: destructive
Input Output

extendTrialClient

clients.extendTrialClient Extend Trial on Klipfolio Risk: write
Input Output

listClients

clients.listClients List Clients on Klipfolio Risk: read
Input Output

retrieveClient

clients.retrieveClient Get Client on Klipfolio Risk: read
Input Output

retrieveClientFeatures

clients.retrieveClientFeatures Get Client Features on Klipfolio Risk: read
Input Output

retrieveClientProperties

clients.retrieveClientProperties Get Client Properties on Klipfolio Risk: read
Input Output

retrieveClientResources

clients.retrieveClientResources Get Client Resources on Klipfolio Risk: read
Input Output

retrieveClientSettings

clients.retrieveClientSettings Get Client Settings on Klipfolio Risk: read
Input Output

retrieveClientShareRights

clients.retrieveClientShareRights Get Client Share Rights on Klipfolio Risk: read
Input Output

setClientShareRights

clients.setClientShareRights Update Client Share Rights on Klipfolio Risk: write
Input Output

updateClient

clients.updateClient Update Client on Klipfolio Risk: write
Input Output

updateClientFeatures

clients.updateClientFeatures Update Client Features on Klipfolio Risk: write
Input Output

updateClientProperties

clients.updateClientProperties Update Client Properties on Klipfolio Risk: write
Input Output

updateClientResources

clients.updateClientResources Update Client Resources on Klipfolio Risk: write
Input Output

Datasources

createDatasource

datasources.createDatasource Create Data Source on Klipfolio Risk: write
Input Output

createDatasourceInstances

datasources.createDatasourceInstances Create Data Source Instance on Klipfolio Risk: write
Input Output

deleteDatasource

datasources.deleteDatasource Delete Data Source on Klipfolio Risk: destructive
Input Output

deleteDatasourceInstances

datasources.deleteDatasourceInstances Delete Data Source Instance on Klipfolio Risk: destructive
Input Output

deleteDatasourceInstancesProperties

datasources.deleteDatasourceInstancesProperties Delete Data Source Instance Property on Klipfolio Risk: destructive
Input Output

deleteDatasourceProperties

datasources.deleteDatasourceProperties Delete a Data Source Property on Klipfolio Risk: destructive
Input Output

deleteDatasourceShareRight

datasources.deleteDatasourceShareRight Delete Data Source Share Right on Klipfolio Risk: destructive
Input Output

deleteInstancesDatasource

datasources.deleteInstancesDatasource Delete Instances on Klipfolio Risk: destructive
Input Output

disableDatasource

datasources.disableDatasource Disable a Data Source on Klipfolio Risk: write
Input Output

enableDatasource

datasources.enableDatasource Enable a Data Source on Klipfolio Risk: write
Input Output

importDatasource

datasources.importDatasource Import a Data Source on Klipfolio Risk: write
Input Output

listDatasourceInstances

datasources.listDatasourceInstances List Data Source Instances on Klipfolio Risk: read
Input Output

listDatasources

datasources.listDatasources List Data Sources on Klipfolio Risk: read
Input Output

refreshDatasource

datasources.refreshDatasource Refresh Multiple Data Sources on Klipfolio Risk: write
Input Output

refreshDatasourceInstances

datasources.refreshDatasourceInstances Refresh a Data Source Instance on Klipfolio Risk: write
Input Output

retrieveDatasource

datasources.retrieveDatasource Get Data Source on Klipfolio Risk: read
Input Output

retrieveDatasourceInstances

datasources.retrieveDatasourceInstances Get Data Source Instance on Klipfolio Risk: read
Input Output

retrieveDatasourceInstancesData

datasources.retrieveDatasourceInstancesData Get Data Source Instance Data on Klipfolio Risk: read
Input Output: string

retrieveDatasourceInstancesProperties

datasources.retrieveDatasourceInstancesProperties Get Data Source Instance Properties on Klipfolio Risk: read
Input Output

retrieveDatasourceProperties

datasources.retrieveDatasourceProperties Get Data Source Properties on Klipfolio Risk: read
Input Output

retrieveDatasourceShareRights

datasources.retrieveDatasourceShareRights Get Data Source Share Rights on Klipfolio Risk: read
Input Output

setDatasourceShareRights

datasources.setDatasourceShareRights Update Data Source Share Rights on Klipfolio Risk: write
Input Output

updateDatasource

datasources.updateDatasource Update Data Source on Klipfolio Risk: write
Input Output

updateDatasourceInstancesData

datasources.updateDatasourceInstancesData Replace a data source instance’s data on Klipfolio Risk: destructive
Input Output

updateDatasourceInstancesProperties

datasources.updateDatasourceInstancesProperties Create or Update Data Source Instance Properties on Klipfolio Risk: write
Input Output

updateDatasourceProperties

datasources.updateDatasourceProperties Create or Update Data Source Properties on Klipfolio Risk: write
Input Output

Groups

addGroupDefaultTabs

groups.addGroupDefaultTabs Add Dashboard to Group on Klipfolio Risk: write
Input Output

createGroup

groups.createGroup Create Group on Klipfolio Risk: write
Input Output

deleteGroup

groups.deleteGroup Delete Group on Klipfolio Risk: destructive
Input Output

deleteGroupDefaultTab

groups.deleteGroupDefaultTab Delete Group Default Tab on Klipfolio Risk: destructive
Input Output

deleteGroupUser

groups.deleteGroupUser Delete User from Group on Klipfolio Risk: destructive
Input Output

listGroups

groups.listGroups List Groups on Klipfolio Risk: read
Input Output

retrieveGroup

groups.retrieveGroup Get Group on Klipfolio Risk: read
Input Output

retrieveGroupDefaultTab

groups.retrieveGroupDefaultTab Get Group Default Tab on Klipfolio Risk: read
Input Output

retrieveGroupDefaultTabs

groups.retrieveGroupDefaultTabs List Group Default Tabs on Klipfolio Risk: read
Input Output

retrieveGroupUsers

groups.retrieveGroupUsers List Users in Group on Klipfolio Risk: read
Input Output

updateGroup

groups.updateGroup Update Group on Klipfolio Risk: write
Input Output

updateGroupDefaultTab

groups.updateGroupDefaultTab Update Group Default Tab on Klipfolio Risk: write
Input Output

updateGroupUser

groups.updateGroupUser Add User to Group on Klipfolio Risk: write
Input Output

Klips

createKlip

klips.createKlip Create Klip on Klipfolio Risk: write
Input Output

createKlipAnnotations

klips.createKlipAnnotations Create annotation on Klipfolio Risk: write
Input Output

deleteKlip

klips.deleteKlip Delete Klip on Klipfolio Risk: destructive
Input Output

deleteKlipAnnotation

klips.deleteKlipAnnotation Delete annotation on Klipfolio Risk: destructive
Input Output

deleteKlipShareRights

klips.deleteKlipShareRights Delete Klip share rights on Klipfolio Risk: destructive
Input Output

importKlip

klips.importKlip Import Klip to client account on Klipfolio Risk: write
Input Output

listKlips

klips.listKlips List Klips on Klipfolio Risk: read
Input Output

retrieveKlip

klips.retrieveKlip Get Klip on Klipfolio Risk: read
Input Output

retrieveKlipAnnotation

klips.retrieveKlipAnnotation Get one annotation on Klipfolio Risk: read
Input Output

retrieveKlipAnnotations

klips.retrieveKlipAnnotations List annotations on Klipfolio Risk: read
Input Output

retrieveKlipClientInstances

klips.retrieveKlipClientInstances Get Klip Client Instances on Klipfolio Risk: read
Input Output

retrieveKlipSchema

klips.retrieveKlipSchema Get Klip schema on Klipfolio Risk: read
Input Output

retrieveKlipShareRights

klips.retrieveKlipShareRights Get Klip share rights on Klipfolio Risk: read
Input Output

setKlipShareRights

klips.setKlipShareRights Update Klip share rights on Klipfolio Risk: write
Input Output

updateFromParentKlip

klips.updateFromParentKlip Update client instance from parent (update_from_parent) on Klipfolio Risk: write
Input Output

updateKlip

klips.updateKlip Update Klip on Klipfolio Risk: write
Input Output

updateKlipAnnotation

klips.updateKlipAnnotation Update annotation on Klipfolio Risk: write
Input Output

updateKlipSchema

klips.updateKlipSchema Update Klip schema on Klipfolio Risk: write
Input
Output

Misc

misc.createDashboardPublishedLinks Create published link on Klipfolio Risk: write
Input Output

misc.deleteDashboardPublishedLinks Delete published link on Klipfolio Risk: destructive
Input Output

misc.listDashboardPublishedLinks Get published link(s) on Klipfolio Risk: read
Input Output

retrieveProfile

misc.retrieveProfile Get profile on Klipfolio Risk: read
Input Output

misc.updateDashboardPublishedLinks Update published link on Klipfolio Risk: write
Input Output

Roles

createRole

roles.createRole Create role on Klipfolio Risk: write
Input Output

deleteRole

roles.deleteRole Delete role on Klipfolio Risk: destructive
Input Output

deleteRolePermissions

roles.deleteRolePermissions Remove role permission on Klipfolio Risk: destructive
Input Output

deleteRoleUser

roles.deleteRoleUser Delete user from role on Klipfolio Risk: destructive
Input Output

listRoles

roles.listRoles List roles on Klipfolio Risk: read
Input Output

retrieveRole

roles.retrieveRole Get role on Klipfolio Risk: read
Input Output

retrieveRolePermissions

roles.retrieveRolePermissions Get role permissions on Klipfolio Risk: read
Input Output

retrieveRoleUsers

roles.retrieveRoleUsers List users for role on Klipfolio Risk: read
Input Output

updateRole

roles.updateRole Update role on Klipfolio Risk: write
Input Output

updateRolePermissions

roles.updateRolePermissions Update role permissions on Klipfolio Risk: write
Input Output

updateRoleUser

roles.updateRoleUser Add user to role on Klipfolio Risk: write
Input Output

Tabs

createTab

tabs.createTab Create tab on Klipfolio Risk: write
Input Output

deleteTab

tabs.deleteTab Delete tab on Klipfolio Risk: destructive
Input Output

deleteTabKlipInstance

tabs.deleteTabKlipInstance Delete Klip from tab on Klipfolio Risk: destructive
Input Output

deleteTabShareRight

tabs.deleteTabShareRight Revoke group access to tab on Klipfolio Risk: destructive
Input Output

importTab

tabs.importTab Import tab to client account on Klipfolio Risk: write
Input Output

listTabs

tabs.listTabs List tabs on Klipfolio Risk: read
Input Output

retrieveTab

tabs.retrieveTab Get tab on Klipfolio Risk: read
Input Output

retrieveTabKlipInstances

tabs.retrieveTabKlipInstances List Klip instances on tab on Klipfolio Risk: read
Input Output

retrieveTabLayout

tabs.retrieveTabLayout Get tab layout on Klipfolio Risk: read
Input Output

retrieveTabShareRights

tabs.retrieveTabShareRights Get tab share rights on Klipfolio Risk: read
Input Output

setTabShareRights

tabs.setTabShareRights Update tab share rights on Klipfolio Risk: write
Input Output

updateTab

tabs.updateTab Update tab on Klipfolio Risk: write
Input Output

updateTabKlipInstances

tabs.updateTabKlipInstances Add Klip to tab on Klipfolio Risk: write
Input Output

updateTabLayout

tabs.updateTabLayout Replace a tab layout on Klipfolio (Klips left out are removed) Risk: destructive
Input Output

Users

createUser

users.createUser Create User on Klipfolio Risk: write
Input Output

deleteUser

users.deleteUser Delete User on Klipfolio Risk: destructive
Input Output

deleteUserGroup

users.deleteUserGroup Delete user from group on Klipfolio Risk: destructive
Input Output

deleteUserProperties

users.deleteUserProperties Delete user property on Klipfolio Risk: destructive
Input Output

deleteUserRole

users.deleteUserRole Delete user from role on Klipfolio Risk: destructive
Input Output

deleteUserTabInstance

users.deleteUserTabInstance Delete user tab instance on Klipfolio Risk: destructive
Input Output

listUsers

users.listUsers Get Users on Klipfolio Risk: read
Input Output

resendInviteUser

users.resendInviteUser Resend the invitation email to a user on Klipfolio Risk: destructive
Input Output

resetPasswordUser

users.resetPasswordUser Reset a user’s password on Klipfolio Risk: destructive
Input Output

retrieveUser

users.retrieveUser Get User by ID on Klipfolio Risk: read
Input Output

retrieveUserGroups

users.retrieveUserGroups Get user groups on Klipfolio Risk: read
Input Output

retrieveUserProperties

users.retrieveUserProperties Get user properties on Klipfolio Risk: read
Input Output

retrieveUserRoles

users.retrieveUserRoles Get user roles on Klipfolio Risk: read
Input Output

retrieveUserTabInstances

users.retrieveUserTabInstances Get user tab instances on Klipfolio Risk: read
Input Output

updateUser

users.updateUser Update User on Klipfolio Risk: write
Input Output

updateUserGroup

users.updateUserGroup Add user to group on Klipfolio Risk: write
Input Output

updateUserProperties

users.updateUserProperties Update user properties on Klipfolio Risk: write
Input Output

updateUserRole

users.updateUserRole Assign user to role on Klipfolio Risk: write
Input Output

updateUserTabInstances

users.updateUserTabInstances Add tabs to user on Klipfolio Risk: write
Input Output