SCIM Gateway
Overview
UNIFYConnect can act as a SCIM 2.0 server, enabling interactions with identity managers and cloud platforms using the SCIM 2.0 specification.
Usage
A SCIM gateway enables create/read/update/delete operations against the adapter entity contexts in UNIFYConnect using the SCIM 2.0 specification. For details on the specification, see rfc7643.
Configuration
In addition to the common gateway configuration shared by all gateways, the SCIM gateway requires the following by way of configuration:
| Name | Supports References | Description |
|---|---|---|
| User Adapter | no | The target adapter that contains User objects, to be represented as SCIM "User" resource type. |
| Group Adapter | no | The target adapter that contains Group objects, to be represented as SCIM "Group" resource type. |
| Address | yes | The address that the endpoint is hosted on. |
| Maximum Query Results | no | The number of query results to fetch in one request. A lower value will result in smaller result sizes, but more requests made. |
| Enable Request Logging | no | Log the full details of SCIM requests made to the configured UNIFYConnect logs. This may include sensitive data and produce a large amount of additional logging data, so it is recommended to only enable in a development build, and disable once it is not longer needed. |
| Authentication Type | no | Choose the authentication type the gateway should require incoming requests to satisfy. Depending on the choice made, additional configuration will be required. See the Authentication section below for more details. |
| User mappings | no | Schema mapping between SCIM fields and Adapter fields for the User object. See SCIM Mapping for more information. Only available if a User Adapter has been selected. |
| Group mappings | no | Schema mapping between SCIM fields and Adapter fields for the Group object. See SCIM Mappingfor more information. Only available if a Group Adapter has been selected. |
Authentication
The SCIM Gateway supports a number of different authentication schemes.
- JWT Bearer
- Secret Token
- Azure AD JWT Bearer (deprecated)
Authentication can also be disabled,by selecting None. This is not recommended in any environment that is exposed to the internet or other untrusted network, or that deals with real user data.
Migration from v5.3 SCIM Gateway
The SCIM gateway in UNIFYConnect v6 received a significant overhaul. As part of the automatic configuration migration process, legacy SCIM gateway configuration will be converted to v6 SCIM gateway configuration. For more information on the conversion process see SCIM Gateway Migration.