Skip to navigation

Group Access Sources

View as Markdown

tool.access-group.sources

MS_GRAPH sources must be ordered AFTER ACTIVE_DIRECTORY/EXCHANGE ones or configuration publish fails.

  • Endpoint: /tool/access-group/sources | 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/sourcesGet group access sources
PATCH/tool/access-group/sourcesUpdate group access sources

Fields

FieldTypeRequiredNotes
group_ingestion_sourcesarray<GroupIngestionSource>Connectors from which email groups are ingested. The list is replaced as a whole on update.
joining_keyenumAttribute used to match copies of the same group across systems, mainly for Microsoft groups (AD, Exchange, O365). One of EMAIL or EXTERNAL_ID; EMAIL is most common. Cannot be changed after creation. One of: EMAIL, EXTERNAL_ID.
common_group_filtersarray<GroupFilter>Filters applied to groups from all ingestion sources.
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.

{
"group_ingestion_sources": [
{
"connector_id": "<connector-uuid>",
"group_filters": [
{
"item_ref": "<string>",
"group_email_filter": {}
}
],
"item_ref": "<string>"
}
],
"joining_key": "EMAIL",
"common_group_filters": [
{
"item_ref": "<string>",
"group_email_filter": {
"disallowed_group_email_addrs": [
"user@example.com"
]
}
}
]
}