SCIM - Custom user schema extension
OneWelcome provides their customers with the possibility to extend the User-schema with additional attributes.
This will give customers the possibility to store attributes that are needed otherwise in the OneWelcome environment.
Custom attributes
Specification of custom attributes needs to include:
- Attribute name. Attribute names cannot contain colons (":").
- Sub-attributes can only be singular; multi-valued sub-attributes are not supported.
- Custom attributes can be simple or complex (e.g. having sub-attributes).
- Custom attributes can be singular or multi-valued.
- Custom attributes and sub-attributes can have any of the attribute types, as defined in SCIM: Core Schema 1.1.
Characteristics
Creation of the extension has the following characteristics:
- OneWelcome can configure the extension in the environment on behalf of the tenant-admin.
- The extension needs to be created before going into production; it needs to happen on an empty database. Changes in schema when identities have already been created may cause identity-data to exist in the database that doesn't comply to the updated custom schema.
- The extension will be named after the customer (e.g. MyCompanyUserExtension).
Behavior
When the extension is configured, the following behavior is applied:
- The extension is applied to all identities of all segments.
- Resulting User-operations (Post, Put, Patch, Get) will support the created extension in a way that is compliant with the Schema Extension model as specified in SCIM: Schema v1.1.
- OneWelcome will apply validation on the (sub)attribute type.
- Custom attributes can be configured as being identifiers for the identity. A typical example would be 'customerNumber', 'subscriptionNumber' or 'licensePlate'.
- OneWelcome's attribute meta data extension is applicable to custom attributes.
Was this page helpful?