Skip to navigation

Group Access Settings

View as Markdown

tool.access-group.setting

  • Endpoint: /tool/access-group/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/access-group/settingGet group access settings
PATCH/tool/access-group/settingUpdate group access settings

Fields

FieldTypeRequiredNotes
hide_details_enabledbooleanIf true, group details are hidden from the user after a successful add (e.g. ‘you can now receive emails from group_name@org.com’).
dl_group_validation_benderobjectData mapping that validates and preprocesses the group email a user provides, for example adding a prefix or changing the domain. Replaced as a whole on update.
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.

{
"hide_details_enabled": true,
"dl_group_validation_bender": {
"object": {
"children": {
"name": {
"simple_eval": {
"expression": {
"rule_v2": "group.name"
}
}
}
}
}
}
}