Skip to navigation

Get group access sources

View as Markdown

Returns your organization’s group access sources. There is one per organization, so there is no id.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Response

Your organization's group access sources
group_ingestion_sourceslist of objectsOptional
Connectors from which email groups are ingested. The list is replaced as a whole on update.
joining_keyenumOptional

Attribute 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.

Allowed values:
common_group_filterslist of objectsOptional
Filters applied to groups from all ingestion sources.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error