{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"Celonis SCIM API\",\"description\":\"The SCIM API allows for the managing groups and users within the Celonis Platform.\",\"contact\":{\"name\":\"Celonis Support\"},\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"/user-provisioning\",\"description\":\"Default Server URL\"}],\"tags\":[{\"name\":\"Discovery\",\"description\":\"Retrieve the most recent configuration and schemata via the following endpoints.\"},{\"name\":\"Bulk API\",\"description\":\"Used to process bulk executions of resource operations.\"},{\"name\":\"Group API\",\"description\":\"For CRUD manipulation of groups and group memberships. Group memberships can only be managed via the Group resource.\"},{\"name\":\"User API\",\"description\":\"For CRUD manipulation of users in a team.\"}],\"paths\":{\"/scim/v2/Users/{id}\":{\"get\":{\"tags\":[\"User API\"],\"summary\":\"Retrieve a user by its ID\",\"operationId\":\"getUser\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"User ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"User was not found.\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"put\":{\"tags\":[\"User API\"],\"summary\":\"Update a user by its ID\",\"description\":\"Updates to a user can also fail, e.g. because of license restrictions. Email updates are forbidden.\",\"operationId\":\"updateUserWithPUT\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the user after the update.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"delete\":{\"tags\":[\"User API\"],\"summary\":\"Delete a user by its ID\",\"description\":\"Deleting a user from a team does not impact any other team memberships that this user might have.\",\"operationId\":\"deleteUser\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"User ID\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"OK, but no content to return.\",\"content\":{}},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups/{id}\":{\"get\":{\"tags\":[\"Group API\"],\"summary\":\"Retrieve a group by its ID\",\"operationId\":\"getGroup\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Group was not found\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"put\":{\"tags\":[\"Group API\"],\"summary\":\"Update a group by its ID\",\"description\":\"A groups members or its role can be changed via an update to it. Group operations can fail due to license constraints. User cannot be a member of more than 50 groups.\",\"operationId\":\"updateGroupWithPUT\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the group after the update.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"delete\":{\"tags\":[\"Group API\"],\"summary\":\"Delete a group by its ID\",\"description\":\"Remove a group from a team with this endpoint. Removing a group does not remove its members from the Celonis Platform team.\",\"operationId\":\"deleteGroup\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"OK, but no content to return.\",\"content\":{}},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Users\":{\"get\":{\"tags\":[\"User API\"],\"summary\":\"Search for users via GET\",\"description\":\"Filtering and searching are not supported.\",\"operationId\":\"search_1\",\"parameters\":[{\"name\":\"startIndex\",\"in\":\"query\",\"description\":\"Index of total result set to start list from\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1}},{\"name\":\"count\",\"in\":\"query\",\"description\":\"Number of items to retrieve, starting at the given index\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Limit result to items that contain these attributes at the minimum. See the [specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Exclude these attributes from the result set. See [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"post\":{\"tags\":[\"User API\"],\"summary\":\"Add a user\",\"description\":\"This adds users to a team. It can fail if the license is exceeded. A user gets the <tt>MEMBER</tt> role by default.\",\"operationId\":\"createUser\",\"parameters\":[{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the user to be created.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\",\"sendEmailOnInvitation\":\"true\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\",\"sendEmailOnInvitation\":\"true\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Users/.search\":{\"post\":{\"tags\":[\"User API\"],\"summary\":\"Search for users via POST\",\"description\":\"Filtering and searching are not supported.\",\"operationId\":\"search\",\"requestBody\":{\"description\":\"A JSON object with fields as in the GET search request.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups\":{\"get\":{\"tags\":[\"Group API\"],\"summary\":\"Search for groups via GET\",\"description\":\"Filtering and sorting are not supported.\",\"operationId\":\"searchOverGet\",\"parameters\":[{\"name\":\"startIndex\",\"in\":\"query\",\"description\":\"Index of total result set to start list from\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1}},{\"name\":\"count\",\"in\":\"query\",\"description\":\"Number of items to retrieve, starting at the given index\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Limit result to items that contain these attributes at the minimum. See the [specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Exclude these attributes from the result set. See [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"post\":{\"tags\":[\"Group API\"],\"summary\":\"Create a group\",\"description\":\"This creates a group inside the team, if it does not exist already. User memberships can already be specified upon creation. Group creation may fail due to license constraints. User cannot be a member of more than 50 groups.\",\"operationId\":\"createGroup\",\"parameters\":[{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the group to be created. The group name must be unique.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups/.search\":{\"post\":{\"tags\":[\"Group API\"],\"summary\":\"Search for groups via POST\",\"description\":\"Filtering and sorting are not supported.\",\"operationId\":\"searchOverPost\",\"requestBody\":{\"description\":\"A JSON object with fields as in the GET search request.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Bulk\":{\"post\":{\"tags\":[\"Bulk API\"],\"operationId\":\"processBulkData\",\"requestBody\":{\"description\":\"A JSON object that describes a series of operations that would otherwise have been sent via single requests. The Bulk API will execute these in sequence and stop after the first operation fails.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"failOnErrors\":1,\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:BulkRequest\"],\"Operations\":[{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk1\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user1+bulk@celonis.com\",\"displayName\":\"Bulk User #1\",\"externalId\":\"{{externalUserId1}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk2\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user2+bulk@celonis.com\",\"displayName\":\"Bulk User #2\",\"externalId\":\"{{externalUserId2}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk3\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId1}}\",\"displayName\":\"SCIM Bulk Group #1 {{externalGroupId1}}\",\"members\":[]}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk4\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId2}}\",\"displayName\":\"SCIM Bulk Group #2 {{externalGroupId2}}\",\"members\":[]}}]}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"failOnErrors\":1,\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:BulkRequest\"],\"Operations\":[{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk1\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user1+bulk@celonis.com\",\"displayName\":\"Bulk User #1\",\"externalId\":\"{{externalUserId1}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk2\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user2+bulk@celonis.com\",\"displayName\":\"Bulk User #2\",\"externalId\":\"{{externalUserId2}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk3\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId1}}\",\"displayName\":\"SCIM Bulk Group #1 {{externalGroupId1}}\",\"members\":[]}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk4\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId2}}\",\"displayName\":\"SCIM Bulk Group #2 {{externalGroupId2}}\",\"members\":[]}}]}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.7.3)\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"string\"}},\"application/json\":{\"schema\":{\"type\":\"string\"}}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ServiceProviderConfig\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve data on the configuration and capabilities of our SCIM implementation\",\"operationId\":\"getServiceProviderConfiguration\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Schemas\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve all schemas currently in use by the Celonis Platform.\",\"operationId\":\"get_schemas\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Schemas/{schemaUrn}\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve specific schema currently in use by the Celonis Platform.\",\"operationId\":\"get_schema\",\"parameters\":[{\"name\":\"schemaUrn\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ResourceTypes\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve all user types available via the SCIM API\",\"operationId\":\"getResourceTypes\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ResourceTypes/{resourceType}\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve specified resource type types available via the SCIM API\",\"operationId\":\"getResourceType\",\"parameters\":[{\"name\":\"resourceType\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}}},\"components\":{\"schemas\":{\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"reference\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"frontendErrorKey\":{\"type\":\"string\"},\"errorInformation\":{\"type\":\"object\"}}}},\"securitySchemes\":{\"Authorization\":{\"type\":\"apiKey\",\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"name\":\"Authorization\",\"in\":\"header\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":true,"settings":{},"requestLogin":false,"lastModified":"2025-08-13T17:40:51.000Z"},"seo":{"title":"Overview"}}},"pageContext":{"id":"6a0f24bd-1ef4-53b1-b7c8-ce4b43ce6c7boverview__redocly content/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","seo":{"title":"Overview","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/scim-api/openapi/scim_openapi_spec.yaml#overview","pageBaseUrl":"/celonis-apis/scim-api/openapi/scim_openapi_spec","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"autogenerated_celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","id":null,"title":null,"isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}