Skip to content

SCIM Gateway Migration

Authentication

If either an Audience or Tenant is set, the authentication type used will be Azure AD JWT Bearer. Otherwise, it will be None.

WARNING

The Azure AD JWT Bearer authentication method is deprecated, and should not be used. None authentication is also not recommended for publicly accessible endpoints. The recommended authentication types are Secret Token or JWT Bearer.

User ID Lookup Field

The legacy User ID Lookup Field setting has no direct configuration in the new gateway, but is used to determine the correct setting for the Mapping Type for the user's manager and group's member fields. If the lookup field was [DN], then the mapping kind used will be Referenced Entity DN. If a adapter schema field is selected, then the mapping kind will be Referenced Entity Field Value using the selected schema field.

For more information on the different mapping types, see SCIM Mappings.

Mapping

The following tables describe the way in which the v5.3 and older SCIM gateway mappings are converted to new mappings. The SCIM paths used are based on the standard schema defined in RFC7643. Only used legacy mappings will be included in converted configuration.

TIP

If the SCIM client used with a gateway allows custom mappings as part of its configuration, ensure that those match up with the gateway mapping's paths. These will need to be updated in cases where the client had been configured to use a non-standard schema.

User

v5.3 Mapping NameMigrated Mapping SCIM Path
activeactive
displayNamedisplayName
departmenturn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department
preferredLanguagepreferredLanguage
titletitle
usernameuserName
managerurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager
employeeNumberurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber
faxNumberphoneNumbers[type eq "fax"].value
givenNamename.givenName
workEmailemails[type eq "work"].value
mobilePhoneNumberphoneNumbers[type eq "mobile"].value
workPostalCodeaddresses[type eq "work"].postalCode
otherEmailemails[type eq "other"].value
otherAddressFormattedaddresses[type eq "other"].formatted
workStreetAddressaddresses[type eq "work"].streetAddress
familyNamename.familyName
workPhoneNumberphoneNumbers[type eq "work"].value
organizationurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization
divisionurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division
workLocalityaddresses[type eq "work"].locality
workCountryaddresses[type eq "work"].country
workRegionaddresses[type eq "work"].region
costCenterurn:ietf:params:scim:schemas:extension:enterprise:2.0:User:costCenter
formattedNamename.formatted

Group

v5.3 Mapping NameMigrated Mapping SCIM Path
displayNamedisplayName
membersmembers
securityEnabledsecurityEnabled

External ID

The externalId is a special value in the SCIM resource schema. The External Id Field will be set based on legacy mappings, but will not be included as a standard mapping.