Cakewalk
API integration

list_all_cakewalk_users

List Cakewalk users. Returns a paginated list of simplified user profiles including id, name, email, and statusName.

cakewalk_users_deactivate

Deactivate a specific Cakewalk user by id. Required: id.

get_single_cakewalk_user_by_id

Get detailed information about a specific Cakewalk user by id. Returns: id, name, email, roleName, statusName, lastLogin, and managerId.

list_all_cakewalk_users_groups

List all users groups in Cakewalk. Returns a paginated list of simplified group objects including id, name, description, isIdpGroup, and isReadOnly.

get_single_cakewalk_users_group_by_id

Get detailed information about a specific Cakewalk users group by id. Returns: id, name, description, isIdpGroup, isReadOnly, numberOfUsers, numberOfDefaultWorkApps, and numberOfHiddenWorkApps. Required: id.

list_all_cakewalk_users_group_default_work_apps

List default work apps associated with a users group in Cakewalk. Returns each entry's workApp (id, name, statusName) and optional permissionLevel (id, name, description). Required: users_group_id.

list_all_cakewalk_users_group_hidden_work_apps

List hidden work apps associated with a specific users group in cakewalk. Returns the collection of hidden work app records. Required: users_group_id.

list_all_cakewalk_users_group_users

List users belonging to a Cakewalk users group. Returns the collection of users in the group. Required: users_group_id.

create_a_cakewalk_users_group_user

Add one or more users to a Cakewalk users group. Returns a 201 Created response on success. Required: users_group_id, userIds, and triggeredByUserId.

delete_a_cakewalk_users_group_user_by_id

Remove a user from a Cakewalk users group. Returns an empty response on success. Required: users_group_id and id.

list_all_cakewalk_work_apps

List all available Work Apps in Cakewalk. Returns: id, name, statusName for each work app.

get_single_cakewalk_work_app_by_id

Get detailed information about a specific Cakewalk Work App by id. Returns: id, name, statusName, categoryName, url, imageUrl, tagLine, description, owner, numberOfAccounts, serverLocations, certifications, and aiRisk. Required: id.

list_all_cakewalk_work_app_accesses

List user accesses for a specific Cakewalk Work App. Returns: isOwner, user (id, name, email, roleName, statusName), permissionLevel, and lastAccessedAt per access entry. Required: work_app_id.

cakewalk_work_app_accesses_bulk_create

Create user access entries for one or more Cakewalk Work Apps in a single bulk request. Returns an empty 201 response on success. Required: data array where each entry requires workAppId and userId.

list_all_cakewalk_work_app_permission_levels

List permission levels for a specific Work App in Cakewalk. Returns the available permission level records associated with the given work app. Required: work_app_id.

update_a_cakewalk_work_app_policy_by_id

Update the policy assigned to a Cakewalk Work App for a specific request type. Returns an empty 204 response on success. Required: work_app_id (Work App identifier), id (request type: GrantAccessRequest, RemoveAccessRequest, ArchiveWorkAppRequest, ChangePermissionLevelRequest, or AddNewManagedWorkAppRequest), and policyId in the body.

update_a_cakewalk_work_app_permission_level_policy_by_id

Update the policy assigned to a specific permission level within a Cakewalk Work App for a given request type. Returns an empty 204 response on success. Required: work_app_id, permission_level_id, id (request type), and policyId.

list_all_cakewalk_work_app_custom_fields

List all custom fields for a specific Cakewalk Work App. Returns: id, name, type, required, value, guidValue. Required: work_app_id.

update_a_cakewalk_work_app_custom_field_by_id

Partially update custom fields for a specific Cakewalk Work App. Required: work_app_id.

list_all_cakewalk_tasks

List Cakewalk tasks for a specific user, optionally filtered by task status. Returns: id, type, status, createdAt, lastUpdatedAt, assignedUserId per task. Required: userId.

get_single_cakewalk_task_by_id

Get detailed information about a specific Cakewalk task by id. Returns: id, type, status, createdAt, lastUpdatedAt, assignedUser, claimers, executedByUser, request, and review metadata. Required: id.

create_a_cakewalk_task_approval

Approve a task in cakewalk by submitting an approval action against the specified task. Required: task_id.

create_a_cakewalk_task_decline

Decline a task in cakewalk. Required: task_id.

list_all_cakewalk_policies

List compatible policy templates for a specific request type in cakewalk (e.g., access or remove). Returns policy templates including their logic, conditions, and approval flow definitions. Required: id (the request type).

create_a_cakewalk_access_review

Create an access review campaign in cakewalk to audit and certify user access across specific apps or all apps. Defines the campaign scope, assignees (such as app owners, line managers, or a review owner), and completion deadline.