4.1. Supported schemas#
SCIM schemas define the attributes of users and user groups. The SCIM Client detects the schemas supported by the SCIM target and uses the matching extensions. The target doesn’t need to support all the extensions listed later. Advertising an additional extension doesn’t provide a mapping for arbitrary application-specific attributes. The client maps the attributes described on this page.
The SCIM Client supports the following schemas when provisioning data to an SCIM target:
4.1.1. User schema#
The following list includes the core User schema from RFC 7643 and the supported extensions:
urn:ietf:params:scim:schemas:core:2.0:Userurn:ietf:params:scim:schemas:extension:enterprise:2.0:Userurn:ietf:params:scim:schemas:extension:Univention:1.0:Userurn:ietf:params:scim:schemas:extension:UniventionUser:2.0:User
4.1.1.1. User attributes#
The core User schema requires userName.
The SCIM Client also requires a nonempty externalId
to identify the corresponding resource at the target.
The target assigns its own id.
For information,
see Matching existing users and groups.
The following list shows the available core mappings.
All other mapped attributes are optional from the client’s perspective
and depend on the available source data and the target’s schema.
If your application requires additional attributes,
make sure that Nubus provides the corresponding values
and that the client has a mapping for them.
The client doesn’t send a password attribute.
Configure user sign-in separately in the target application, for example through single sign-on or the application’s invitation and password setup process.
externalId- Nubus UDM property:
univentionObjectIdentifierby default- Mapping:
Required by the client.
Configurable through
scimClient.config.externalIdUserMapping.
userName- Nubus UDM property:
usernameby default- Mapping:
Required for a user.
Configurable through
scimClient.config.usernameMapping.
active- Nubus UDM property:
disabled- Mapping:
The inverse Boolean value.
A deactivated user maps to
active: false.
name.givenName- Nubus UDM property:
firstname- Mapping:
The user’s first name.
name.familyName- Nubus UDM property:
lastname- Mapping:
The user’s last name.
name.formatted- Nubus UDM properties:
firstname,lastname- Mapping:
First and last name, joined with a space when both are present.
displayName- Nubus UDM property:
displayName- Mapping:
The source display name.
title- Nubus UDM property:
title- Mapping:
The source title.
userType- Nubus UDM property:
employeeType- Mapping:
The source employee type.
preferredLanguage- Nubus UDM property:
preferredLanguage- Mapping:
The source language preference.
emails- Nubus UDM properties:
mailPrimaryAddress,mailAlternativeAddress,e-mail- Mappings:
Entries with types
mailbox,alias, andother, respectively.The client sets
primarytotrueformailPrimaryAddress. It setsprimarytofalsefor the other entries.
phoneNumbers- Nubus UDM properties:
phone,mobileTelephoneNumber,homeTelephoneNumber,pagerTelephoneNumber- Mappings:
Entries with types
work,mobile,home, andpager, respectively.
addresses- Nubus UDM properties:
street,city,postcode,state,country,homePostalAddress- Mapping:
A work address from the individual properties and home addresses from
homePostalAddress.
roles- Nubus UDM properties:
guardianRoles,guardianInheritedRoles- Mapping:
Entries with types
guardian-directandguardian-indirect, respectively.
photos- Nubus UDM property:
jpegPhoto- Mapping:
A photo entry with a
data:image/jpeg;base64,...URI.
x509Certificates- Nubus UDM properties:
userCertificate,certificateSubjectCommonName- Mapping:
A certificate entry with the certificate as
valueand its common name asdisplay.
4.1.1.2. User extension attributes#
The client maps the following extension attributes when the target advertises the corresponding extension:
urn:ietf:params:scim:schemas:extension:enterprise:2.0:UserOther enterprise attributes, such as
departmentormanager, aren’t mapped.employeeNumber- Nubus UDM property:
employeeNumber
urn:ietf:params:scim:schemas:extension:Univention:1.0:Userdescription- Nubus UDM property:
description
passwordRecoveryEmail- Nubus UDM property:
PasswordRecoveryEmail
urn:ietf:params:scim:schemas:extension:UniventionUser:2.0:UserprimaryOrgUnit- Nubus UDM property:
primaryOrgUnit
secondaryOrgUnits- Nubus UDM property:
secondaryOrgUnits
4.1.2. Group schema#
The following list includes the core Group schema from RFC 7643
and the supported extension:
urn:ietf:params:scim:schemas:core:2.0:Groupurn:ietf:params:scim:schemas:extension:Univention:1.0:Group
The scimClient.config.groupSync setting controls
whether the client provisions user groups.
For more information,
see Optional values.
4.1.2.1. Group attributes#
The core Group schema requires displayName.
The following list shows the available core mappings.
externalId- Nubus UDM property:
univentionObjectIdentifierby default- Mapping:
Required by the client. Configurable through
scimClient.config.externalIdGroupMapping.
displayName- Nubus UDM property:
name- Mapping:
Required for a group. The source group name.
members- Nubus UDM property:
users- Mapping:
Direct user memberships, resolved to the corresponding users at the SCIM target.
For direct user memberships,
the client maps the target-assigned user ID to members.value.
It also maps type: User
and the target user’s displayName to display
when the target’s schema supports these attributes.
The client omits members that it can’t find at the SCIM target.
For the group membership restrictions, see Data synchronization.
4.1.2.2. Group extension attributes#
The client maps the following extension attributes when the target advertises the corresponding extension:
urn:ietf:params:scim:schemas:extension:Univention:1.0:Groupdescription- Nubus UDM property:
description
guardianMemberRoles- Nubus UDM property:
memberRoles- Mapping:
Entries with
type: guardian.