[SYNCOPE-1822] SCIM: support user extension

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0.8, 4.0.0
• Component/s: documentation, extensions
• Labels: scim
• Assignee: Samuel Garofalo
• Reporter: Francesco Chicchiriccò
• Created: 18/Jun/24 14:31
• Updated: 21/Oct/24 09:32
• Resolved: 03/Jul/24 14:01

Description

Syncope currently allows to manage JSON payloads as follows:

{
  "schemas":
    ["urn:ietf:params:scim:schemas:core:2.0:User",
     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
  "id": "2819c223-7f76-453a-919d-413861904646",
  "externalId": "701984",
  "userName": "[e-mail]",
  ...
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "701984",
  ...
  }
}

by mapping all attributes from the SCIM 2.0 specs to Syncope schemas.

Enterprise User, in particular, is a standard SCIM 2.0 extension with well-defined attributes.

We want to enable Syncope to allow JSON payloads as follows:

{
  "schemas":
    ["urn:ietf:params:scim:schemas:core:2.0:User",
     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
     "urn:ietf:params:scim:schemas:extension:syncope:2.0:User"],
  "id": "2819c223-7f76-453a-919d-413861904646",
  "externalId": "701984",
  "userName": "[e-mail]",
  ...
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "employeeNumber": "701984",
  ...
  }
  "urn:ietf:params:scim:schemas:extension:syncope:2.0:User": {
    "myfancyparam": "my fancy value",
  ...
  }
}

In this way, one can add as many custom attributes as needed, via the urn:ietf:params:scim:schemas:extension:syncope:2.0:User SCIM 2.0 extension.

Issue Links

• causes: SYNCOPE-1833 Non-compliant SCIM payload returned when user extension is defined
• relates to: SYNCOPE-1823 SCIM: support search by extension attributes
• links to: GitHub Pull Request #769
• links to: GitHub Pull Request #773