# Celonis SCIM API

The SCIM API allows for the managing groups and users within the Celonis Platform.

Version: 1.0.0

## Servers

Default Server URL
```
/
```

## Security

### Authorization

Please, prefix the Token with "AppKey " or "Bearer " (word and space) to indicate the Authorization type

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[Celonis SCIM API](https://developer.celonis.com/_bundle/celonis-apis/scim-api/openapi/scim_openapi_spec.yaml)

## Discovery

Retrieve the most recent configuration and schemata via the following endpoints.

### Retrieve data on the configuration and capabilities of our SCIM implementation

 - [GET /scim/v2/ServiceProviderConfig](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/discovery/getserviceproviderconfiguration.md)

### Retrieve all schemas currently in use by the Celonis Platform.

 - [GET /scim/v2/Schemas](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/discovery/get_schemas.md)

### Retrieve specific schema currently in use by the Celonis Platform.

 - [GET /scim/v2/Schemas/{schemaUrn}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/discovery/get_schema.md)

### Retrieve all user types available via the SCIM API

 - [GET /scim/v2/ResourceTypes](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/discovery/getresourcetypes.md)

### Retrieve specified resource type types available via the SCIM API

 - [GET /scim/v2/ResourceTypes/{resourceType}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/discovery/getresourcetype.md)

## Bulk API

Used to process bulk executions of resource operations.

### processBulkData

 - [POST /scim/v2/Bulk](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/bulk-api/processbulkdata.md)

## Group API

For CRUD manipulation of groups and group memberships. Group memberships can only be managed via the Group resource.

### Retrieve a group by its ID

 - [GET /scim/v2/Groups/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/getgroup.md)

### Update a group by its ID

 - [PUT /scim/v2/Groups/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/updategroupwithput.md): 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.

### Delete a group by its ID

 - [DELETE /scim/v2/Groups/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/deletegroup.md): Remove a group from a team with this endpoint. Removing a group does not remove its members from the Celonis Platform team.

### Search for groups via GET

 - [GET /scim/v2/Groups](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/searchoverget.md): Filtering and sorting are not supported.

### Create a group

 - [POST /scim/v2/Groups](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/creategroup.md): 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.

### Search for groups via POST

 - [POST /scim/v2/Groups/.search](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/group-api/searchoverpost.md): Filtering and sorting are not supported.

## User API

For CRUD manipulation of users in a team.

### Retrieve a user by its ID

 - [GET /scim/v2/Users/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/getuser.md)

### Update a user by its ID

 - [PUT /scim/v2/Users/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/updateuserwithput.md): Updates to a user can also fail, e.g. because of license restrictions. Email updates are forbidden.

### Delete a user by its ID

 - [DELETE /scim/v2/Users/{id}](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/deleteuser.md): Deleting a user from a team does not impact any other team memberships that this user might have.

### Search for users via GET

 - [GET /scim/v2/Users](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/search_1.md): Filtering and searching are not supported.

### Add a user

 - [POST /scim/v2/Users](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/createuser.md): This adds users to a team. It can fail if the license is exceeded. A user gets the MEMBER role by default.

### Search for users via POST

 - [POST /scim/v2/Users/.search](https://developer.celonis.com/celonis-apis/scim-api/openapi/scim_openapi_spec/user-api/search.md): Filtering and searching are not supported.