Skip to navigation

Native Plugins

View as Markdown

tool.setting

The plugin permission gates: every plugin has launch_config.access_rule_dsl (“true” = all users, “false” = off, or a user-context MWDSL cohort rule).

  • Endpoint: /tool/setting | Methods: GET, PATCH
  • Request shape: one per organization, so there is no id. It already exists: read it with GET, then PATCH the fields you want to change. Fields go at the top level of the JSON body, with no resource wrapper.
  • Updates: a JSON merge-patch. Send only the fields you change, plus version: {num, change_description} with the num from your last read. Lists and maps you send replace the stored ones whole.

Endpoints

All paths are relative to https://api.moveworks.ai/configurations/v1alpha1. Each endpoint page lists the request and response schema, an example, and the errors it can return.

MethodPathEndpoint reference
GET/tool/settingGet native plugin settings
PATCH/tool/settingUpdate native plugin settings

Fields

FieldTypeRequiredNotes
searchNativeSearchPluginsGroupSettings for search plugins, such as forms, rooms, people and enterprise search.
user_preferencesNativeUserPreferencesPluginsGroupSettings for user preference plugins, such as changing the response language.
ticketingNativeTicketingPluginsGroupSettings for ticketing plugins, such as viewing, resolving, reopening and commenting on tickets.
access_provisioningNativeAccessProvisioningPluginsGroupSettings for access provisioning plugins, such as distribution list management and software access.
access_accountNativeAccessAccountPluginsGroupSettings for account access plugins, such as unlocking accounts and resetting passwords or MFA.
approvalsNativeApprovalsPluginsGroupSettings for approvals plugins, such as viewing, listing and acting on approval records.
llm_passthroughNativePassthroughPluginsGroupSettings for general writing plugins, such as writing emails and translating text.
smart_handoffNativeSmartHandoffPluginsGroupSettings for the smart handoff plugin.
gptNativeGPTPluginsGroupSettings for generative AI plugins, such as QuickGPT and world knowledge web search.
updated_timestringread-onlyWhen the configuration was last updated.
updated_bystringread-onlyWho last updated the configuration.
versionVersionDocument version. On update, send back the num from your last read.

Document fields (example)

The document as GET returns it. To change any of these, send only the fields you want to change in the PATCH body.

{
"search": {
"forms_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"room_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"people_plugin_multifield": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"brief_me_interactions_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"enterprise_search_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"user_preferences": {
"change_language_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"brief_me_start_end_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"ticketing": {
"display_ticket_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"resolve_ticket_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"reopen_ticket_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"add_comment_to_ticket_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"add_translated_comment_to_ticket_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"list_tickets_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"access_provisioning": {
"add_to_dl_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"remove_from_dl_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"create_dl_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"check_dl_membership_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"find_dl_owner_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"access_sw_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"access_account": {
"unlock_account_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"reset_password_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"reset_mfa_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"change_password_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"approvals": {
"display_approval_record_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"approval_record_action_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"list_approval_records_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"llm_passthrough": {
"write_email_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
},
"translate_text_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
},
"smart_handoff": {
"smart_handoff_plugin": {
"launch_config": {},
"fixed_response_plugin_message_config": {}
}
}
}