> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Get identity ingestion

GET https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration

Returns your organization's identity ingestion. There is one per organization, so there is no `id`.

Reference: https://docs.moveworks.com/api-reference/configuration-api/platform-org/identity-ingestion-integration/get-identity-ingestion

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Response

### 200

Your organization's identity ingestion

- `sources` (list of Source, optional) — Identity sources used to build the Moveworks user profile. On update, include every source to keep; omitted sources are removed. 1 to 99 sources.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.
- `override_user_profile_mappings` (map from string to string, optional) — Mappings applied after all sources are merged, overriding user profile fields with values from other sources. On update, send the full map; omitted entries are removed.

## Errors

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 404 Not Found Error

Not found - this configuration has never been written for your organization

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### Source

- `connector_id` (string, optional) — ID of the connector this identity source ingests from. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `primary` (boolean, optional) — If true, this is the primary identity source. Exactly one source is primary, and only users present in it are included. Cannot be moved to another source once set.
- `processors` (list of Processor, optional) — Post-processing steps applied to the user data imported from this source. Up to 20.
- `filters` (list of SourceFilter, optional) — Filters that narrow the users ingested from this source, plus source-specific attribute lists. Up to 20.
- `item_ref` (string, optional) — Identifier the server assigns to this source. Leave it unset to add a new source; send back the value from your last read to update an existing one.
- `joining_key` (string, optional) — Attribute in this source that identifies the user across sources (e.g. email_addr, employee_id). Cannot be changed once the source exists.
- `user_profile_mappings` (map from string to string, optional) — Mappings from this source's attributes to Moveworks user profile fields. For the primary source, these fields appear in the final profile. On update, send the full map; omitted entries are removed.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### Processor

- `user_timezone_processor` (UserTimezoneProcessor, optional) — Resolves each user's timezone into the user profile.
- `user_filter_processor` (UserFilterProcessor, optional) — Filters out users whose attribute matches any of the listed values.
- `user_password_meta_info_processor` (UserPasswordMetaInfoProcessor, optional) — Fills in missing password last-changed or expiry dates using your password expiry policy.
- `user_geocode_processor` (UserGeocodeProcessor, optional) — Resolves user geocodes from location attributes in the user profile.
- `dsl_first_match_dedupe_processor` (DSLFirstMatchDedupeProcessor, optional) — Removes duplicate users, keeping the record that matches a Moveworks DSL rule.
- `filter_rule_post_processor` (FilterRulePostProcessor, optional) — Removes user records that do not satisfy a Moveworks DSL rule.
- `unified_resolve_manager_processor` (UnifiedResolveManagerProcessor, optional) — Resolves each user's manager into the user profile.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### SourceFilter

- `generic_filter` (GenericSourceFilter, optional) — Generic filter using an API query string and/or attribute list.
- `cherwell_filter` (CherwellSourceFilter, optional) — Filter for a Cherwell identity source.
- `ms_teams_filter` (MSTeamsSourceFilter, optional) — Filter for a Microsoft Teams identity source.
- `exchange_filter` (ExchangeSourceFilter, optional) — Filter for an Exchange Online identity source.
- `ms_graph_filter` (MSGraphSourceFilter, optional) — Filter for a Microsoft Graph (Entra ID) identity source.
- `s3_filter` (S3Filter, optional) — Filter for an Amazon S3 roster file source.
- `fresh_desk_filter` (FreshDeskSourceFilter, optional) — Filter for a Freshdesk identity source.
- `sharepoint_online_filter` (SharepointOnlineSourceFilter, optional) — Filter for a SharePoint Online identity source.
- `salesforce_filter` (SalesforceSourceFilter, optional) — Filter for a Salesforce identity source.
- `github_filter` (GithubSourceFilter, optional) — Filter for a GitHub identity source.
- `gdrive_filter` (GdriveSourceFilter, optional) — Filter for a Google Drive identity source.
- `confluence_filter` (ConfluenceSourceFilter, optional) — Filter for a Confluence Cloud identity source.
- `gsuite_filter` (GSuiteSourceFilter, optional) — Filter for a Google Workspace identity source.
- `gdrive_ng_filter` (GdriveNGSourceFilter, optional) — Filter for a Google Drive identity source (next-generation connector).
- `sharepoint_one_drive_ng_filter` (SharepointOneDriveNGSourceFilter, optional) — Filter for a SharePoint and OneDrive identity source (next-generation connector).
- `confluence_server_filter` (ConfluenceServerSourceFilter, optional) — Filter for a Confluence Server identity source.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### UserTimezoneProcessor

### UserFilterProcessor

- `filter_key` (string, optional) — Attribute used to filter out users from this source. 1 to 50 characters.
- `filter_list` (list of string, optional) — Values of the filter attribute that, when matched, filter out the user. At least one is required.

### UserPasswordMetaInfoProcessor

- `offset_days` (integer, optional) — Number of days added to your password expiry period when calculating a missing password last-changed or expiry date.

### UserGeocodeProcessor

- `location_fields` (list of string, optional) — User profile attributes used to resolve geocodes. Defaults to country_code.

### DSLFirstMatchDedupeProcessor

- `rule_dsl` (string, optional) — Moveworks DSL rule selecting which user to keep when duplicates are found, e.g. record.cost_center_name != 'external'.
- `index_key` (string, optional) — Field shared by duplicate users, used to detect duplicates.

### FilterRulePostProcessor

- `rule_dsl` (string, optional) — Moveworks DSL rule; user records that do not satisfy it are removed.

### UnifiedResolveManagerProcessor

### GenericSourceFilter

- `filter_query` (string, optional) — API query string, as described in the source system's API documentation, that filters the users ingested.
- `attributes` (list of string, optional) — User attributes to ingest from the source.

### CherwellSourceFilter

- `business_object_id` (string, optional) — ID (busObId) of the User business object in your Cherwell instance.
- `fields` (list of string, optional) — Field IDs of the user fields to import from Cherwell. At least one is required.

### MSTeamsSourceFilter

- `team_id` (string, optional) — Azure AD ID of the Team containing the users to import.

### ExchangeSourceFilter

- `user` (string, optional) — Exchange Online user (mailbox) identifier that scopes which users are imported.
- `filter_query` (string, optional) — Optional PowerShell filter for the user list, e.g. RecipientType -eq UserMailbox.
- `attributes` (list of string, optional) — User attributes to import from Exchange Online. If empty, all attributes are imported.

### MSGraphSourceFilter

- `group_id` (string, optional) — Azure AD ID of the group containing the users to import.
- `filter_query` (string, optional) — OData filter query that limits the users imported from Microsoft Graph, e.g. (accountEnabled eq true).
- `attributes` (list of string, optional) — User attributes to import. If empty, only the common properties are fetched.

### S3Filter

- `s3_url` (string, optional) — S3 URL where the roster data is stored. Must start with s3://.

### FreshDeskSourceFilter

- `ingest_agents_enabled` (boolean, optional) — If true, Freshdesk agents are also ingested. Requires the bot account to have admin privileges in your workspace.

### SharepointOnlineSourceFilter

- `sites` (list of string, optional) — SharePoint Online sites to import users from. Specify subsites as site/subsite. At least one is required.

### SalesforceSourceFilter

- `table_name` (enum, optional) — Salesforce table to ingest users from: User or Contact.
  - Allowed values: `User`, `Contact`
- `filter_query` (string, optional) — SOQL condition that filters the users imported from Salesforce.
- `attributes` (list of string, optional) — User attributes to import. If empty, Id, Email, LastName, FirstName and Name are imported.

### GithubSourceFilter

- `github_org_name` (string, optional) — Name of the GitHub organization to import users from.

### GdriveSourceFilter

- `customer_id` (string, optional) — Google Workspace customer ID, found on the profile page in the Google Admin console.
- `custom_schemas` (list of string, optional) — Google Workspace custom schemas to retrieve additional user attributes from.

### ConfluenceSourceFilter

- `override_group_id` (string, optional) — ID of a group containing the complete set of Confluence users. If unset, users in the confluence-users and confluence-administrators groups are ingested.

### GSuiteSourceFilter

- `custom_schemas` (list of string, optional) — Google Workspace custom schemas to retrieve additional user attributes from.

### GdriveNGSourceFilter

- `customer_id` (string, optional) — Google Workspace customer ID, found on the profile page in the Google Admin console.
- `custom_schemas` (list of string, optional) — Google Workspace custom schemas to retrieve additional user attributes from.

### SharepointOneDriveNGSourceFilter

- `group_id` (string, optional) — Azure AD ID of the group containing the users to import.
- `filter_query` (string, optional) — OData filter query that limits the users imported from SharePoint and OneDrive.
- `attributes` (list of string, optional) — User attributes to import. If empty, only the common properties are fetched.

### ConfluenceServerSourceFilter

- `override_group_names` (list of string, optional) — Names of the groups to ingest users from, replacing the default confluence-users and confluence-administrators groups. At least one is required.

## Examples

**Response**

```json
{
  "sources": [
    {
      "connector_id": "<connector-uuid>",
      "primary": true,
      "processors": [
        {
          "user_timezone_processor": {
            "...": "see UserTimezoneProcessor"
          },
          "item_ref": "<string>"
        }
      ],
      "filters": [
        {
          "generic_filter": {},
          "item_ref": "<string>"
        }
      ],
      "item_ref": "<string>",
      "joining_key": "<string>",
      "user_profile_mappings": {}
    }
  ],
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial setup"
  },
  "override_user_profile_mappings": {}
}
```

**SDK Code**

```python Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Identity Ingestion (Integration) endpoints_getIdentityIngestion_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/identity/integration")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```