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://orr.api.report.finance/docs/guides/features/scim-mappings#set-up-provisioning.Available Operations
- ListMappings - List SCIM group mappings
Create- Create a SCIM group mapping ⚠️ DeprecatedDelete- Delete a SCIM group mapping ⚠️ Deprecated- Read - Get a SCIM group mapping
Update- Update a SCIM group mapping ⚠️ Deprecated- ListGroups - List SCIM groups
CreateSyncJob- Start a SCIM directory sync ⚠️ Deprecated- GetSyncJob - Get SCIM directory sync status
ListMappings
List SCIM group-to-workspace mappings for the organization. Management key required.Example Usage
Parameters
Response
*operations.ListScimGroupMappingsResponse, errorErrors
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.
Example Usage
Parameters
Response
*components.CreateScimGroupMappingResponse, errorErrors
Delete
Delete a SCIM group-to-workspace 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.
Example Usage
Parameters
Response
*components.DeleteScimGroupMappingResponse, errorErrors
Read
Get a SCIM group-to-workspace mapping. Management key required.Example Usage
Parameters
Response
*components.GetScimGroupMappingResponse, errorErrors
Update
Update a SCIM group mapping role. 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.
Example Usage
Parameters
Response
*components.UpdateScimGroupMappingResponse, errorErrors
ListGroups
List SCIM groups for the organization. Management key required.Example Usage
Parameters
Response
*operations.ListScimGroupsResponse, errorErrors
CreateSyncJob
Start a SCIM directory sync. 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.