The SCIM protocol is an application-level, REST protocol for provisioning and managing identity data on the web. The protocol supports creation, modification, retrieval, and discovery of core identity resources (users, groups, as well as custom resource extensions).
OneWelcome currently supports Version 1.1 of the SCIM protocol specification. In addition to this version, OneWelcome supports a custom implementation for Version 1.1 SCIM protocol which introduces attribute value metadata in the response.
Depending on the configuration, different sets of APIs can be used, that are accessible using different security schemas. For a detailed description of each API version, please follow the link to the API definition that was added to each version.
In order to use SCIM API it is important to understand the differences between different API versions available, therefore the following table contains all the necessary information:
| SCIM API | Security | Description |
|---|---|---|
| /(v1|v2)/Users | Basic | These versions are protected with Basic authentication. |
| /v1.1/Users | Basic | This version is protected with Basic authentication. |
| /secure/(v1|v2)/Users | OAuth 2.0 | The API is protected with OAuth 2.0 scopes, describing API operation. |
| /secure/v1.1/Users | OAuth 2.0 | The API is protected with OAuth 2.0 scopes, describing API operation. |
| /oauth2/secure/(v1|v2)/Users | OAuth 2.0 | The API is protected with OAuth 2.0 scopes, describing API operation but also with scopes that describes to what parts of the data an application/user has access to. |
| /oauth2/secure/v1.1/Users | OAuth 2.0 | The API is protected with OAuth 2.0 scopes, describing API operation but also with scopes that describes to what parts of the data an application/user has access to. |
Please note that the main difference in the implementation of OneWelcome is that v2 introduces attribute value metadata and how multivalued attributes are filtered.