---
name: identity-sources-routes
description: Handle 23 OpenAPI operation(s) under /api/v1/identity-sources/{identitySourceId} for the identity sources route group.
---

# identity sources API Routes

Handle 23 OpenAPI operation(s) under /api/v1/identity-sources/{identitySourceId} for the identity sources route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### create_identity_source_groups

- Operation ID: `create_identity_source_groups`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups`
- Mode: WRITE
- Summary: Create an identity source group
- Parameters:
  - `identitySourceId` in `path` required
- Body: JSON request body accepted.

### get_identity_source_group

- Operation ID: `get_identity_source_group`
- Route: `GET /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}`
- Mode: READ
- Summary: Retrieve an identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required

### update_identity_source_groups

- Operation ID: `update_identity_source_groups`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}`
- Mode: WRITE
- Summary: Update an identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required
- Body: JSON request body accepted.

### delete_identity_source_group

- Operation ID: `delete_identity_source_group`
- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}`
- Mode: WRITE
- Summary: Delete an identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required

### get_identity_source_group_memberships

- Operation ID: `get_identity_source_group_memberships`
- Route: `GET /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership`
- Mode: READ
- Summary: Retrieve the memberships for the given identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required
  - `after` in `query`
  - `limit` in `query`

### create_identity_source_groups_memberships

- Operation ID: `create_identity_source_groups_memberships`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership`
- Mode: WRITE
- Summary: Create the memberships for the given identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required
- Body: JSON request body accepted.

### delete_identity_source_group_memberships

- Operation ID: `delete_identity_source_group_memberships`
- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/groups/{groupOrExternalId}/membership/{memberExternalId}`
- Mode: WRITE
- Summary: Delete the memberships for the specified identity source group
- Parameters:
  - `identitySourceId` in `path` required
  - `groupOrExternalId` in `path` required
  - `memberExternalId` in `path` required

### list_identity_source_sessions

- Operation ID: `list_identity_source_sessions`
- Route: `GET /api/v1/identity-sources/{identitySourceId}/sessions`
- Mode: READ
- Summary: List all identity source sessions
- Parameters:
  - `identitySourceId` in `path` required

### create_identity_source_session

- Operation ID: `create_identity_source_session`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions`
- Mode: WRITE
- Summary: Create an identity source session
- Parameters:
  - `identitySourceId` in `path` required

### get_identity_source_session

- Operation ID: `get_identity_source_session`
- Route: `GET /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}`
- Mode: READ
- Summary: Retrieve an identity source session
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required

### delete_identity_source_session

- Operation ID: `delete_identity_source_session`
- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}`
- Mode: WRITE
- Summary: Delete an identity source session
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required

### upload_identity_source_data_for_delete

- Operation ID: `upload_identity_source_data_for_delete`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-delete`
- Mode: WRITE
- Summary: Upload the data to be deleted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### upload_identity_source_group_memberships_for_delete

- Operation ID: `upload_identity_source_group_memberships_for_delete`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-delete`
- Mode: WRITE
- Summary: Upload the group memberships to be deleted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### upload_identity_source_group_memberships_for_upsert

- Operation ID: `upload_identity_source_group_memberships_for_upsert`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-group-memberships-upsert`
- Mode: WRITE
- Summary: Upload the group memberships to be upserted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### upload_identity_source_groups_data_for_delete

- Operation ID: `upload_identity_source_groups_data_for_delete`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-delete`
- Mode: WRITE
- Summary: Upload the group external IDs to be deleted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### upload_identity_source_groups_for_upsert

- Operation ID: `upload_identity_source_groups_for_upsert`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-groups-upsert`
- Mode: WRITE
- Summary: Upload the group profiles without memberships to be upserted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### upload_identity_source_data_for_upsert

- Operation ID: `upload_identity_source_data_for_upsert`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/bulk-upsert`
- Mode: WRITE
- Summary: Upload the data to be upserted in Okta
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required
- Body: JSON request body accepted.

### start_import_from_identity_source

- Operation ID: `start_import_from_identity_source`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/sessions/{sessionId}/start-import`
- Mode: WRITE
- Summary: Start the import from the identity source
- Parameters:
  - `identitySourceId` in `path` required
  - `sessionId` in `path` required

### create_identity_source_user

- Operation ID: `create_identity_source_user`
- Route: `POST /api/v1/identity-sources/{identitySourceId}/users`
- Mode: WRITE
- Summary: Create an identity source user
- Parameters:
  - `identitySourceId` in `path` required
- Body: JSON request body accepted.

### get_identity_source_user

- Operation ID: `get_identity_source_user`
- Route: `GET /api/v1/identity-sources/{identitySourceId}/users/{externalId}`
- Mode: READ
- Summary: Retrieve an identity source user
- Parameters:
  - `identitySourceId` in `path` required
  - `externalId` in `path` required

### replace_existing_identity_source_user

- Operation ID: `replace_existing_identity_source_user`
- Route: `PUT /api/v1/identity-sources/{identitySourceId}/users/{externalId}`
- Mode: WRITE
- Summary: Replace an existing identity source user
- Parameters:
  - `identitySourceId` in `path` required
  - `externalId` in `path` required
- Body: JSON request body accepted.

### update_identity_source_users

- Operation ID: `update_identity_source_users`
- Route: `PATCH /api/v1/identity-sources/{identitySourceId}/users/{externalId}`
- Mode: WRITE
- Summary: Update an identity source user
- Parameters:
  - `identitySourceId` in `path` required
  - `externalId` in `path` required
- Body: JSON request body accepted.

### delete_identity_source_user

- Operation ID: `delete_identity_source_user`
- Route: `DELETE /api/v1/identity-sources/{identitySourceId}/users/{externalId}`
- Mode: WRITE
- Summary: Delete an identity source user
- Parameters:
  - `identitySourceId` in `path` required
  - `externalId` in `path` required