SCIM API versions
The SCIM protocol is an application-level, REST protocol for provisioning and managing identity data on the web. The protocol supports the creation, modification, retrieval, and discovery of core identity resources, including users and custom resource extensions.
The OneWelcome Identity Platform supports three SCIM API versions: v1, v1.1, and v2. The v2 introduced attribute value metadata (urn:scim:schemas:extension:iwelcomeattributevaluemetadata:1.0) in the request and response and filters multi-valued attributes differently.
Depending on your configuration, you can use different sets of APIs that are accessible using different security schemas. For a detailed description of each API version, follow the link to the API definition that was added to each version.
To use the SCIM API, it is important to understand the differences between the different API versions that are available:
| SCIM API | Security | Description |
|---|---|---|
/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 that describe an API operation and specify which parts of the data an application user can access. |
/oauth2/secure/v1.1/Users |
OAuth 2.0 | The API is protected with OAuth 2.0 scopes that describe an API operation and specify which parts of the data an application user can access. |
