suvera / scim2-compliance-test-utility

SCIM 2.0 Compliance Test Utility
https://suvera.github.io/
MIT License
11 stars 6 forks source link

Question: should `meta` be marked as a required property for `/ResourceTypes` discovery endpoint? #6

Closed seikenberry9 closed 2 months ago

seikenberry9 commented 2 months ago

We are implementing a SCIM server using the elimity scim library. When testing compliance with this utility, the following error is returned for the /ResourcesTypes endpoint: error: object has missing required properties (["meta"]).

The SCIM RFC seems to read that meta is not required to be in the response from discovery endpoints:

Each SCIM resource (Users, Groups, etc.) includes the following common attributes. With the exception of the "ServiceProviderConfig" and "ResourceType" server discovery endpoints and their associated resources, these attributes MUST be defined for all resources, including any extended resource types.

Should meta be required in the response from the discovery endpoint? Thanks!

suvera commented 2 months ago

Yes, in a SCIM 2.0 server response for the /ResourceTypes endpoint, the meta attribute is mandatory.

The meta attribute provides essential metadata about the resource type itself, such as:

This information is crucial for clients interacting with your SCIM server, as it helps them understand the structure and capabilities of the supported resource types.

Key Points:

If you omit the meta attribute, your SCIM server will not be compliant with the SCIM 2.0 specification, and clients may encounter issues when trying to interact with it.