MicrosoftDocs / azure-docs

Open source documentation of Microsoft Azure
https://docs.microsoft.com/azure
Creative Commons Attribution 4.0 International
10.3k stars 21.48k forks source link

'manager' is a complex type according to RFC 7643, but in this doc it is presented as a single value #69234

Closed Bellarmine-Head closed 3 years ago

Bellarmine-Head commented 3 years ago

In section https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/use-scim-to-provision-users-and-groups#table-1-outline-the-attributes-that-you-need of this document, in the JSON payload example, we see:

     "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
     "Manager": "123456"
   },

However, according to my reading of https://tools.ietf.org/html/rfc7643#page-26 (section 4.3. Enterprise User Schema Extension), "manager" should have a lower-case 'm' and it should be a complex type. The value "123456" should presumably be in 'attribute' "value", i.e.

"manager": {
  "value": "123456"
}

Note also that 'attribute' "$ref" of this complex type is also listed as both "RECOMMENDED" on https://tools.ietf.org/html/rfc7643#page-27 and "REQUIRED" on https://tools.ietf.org/html/rfc7643#page-72

Being both recommended and required is somewhat confusing and possibly an error, but be that as it may, it would seem clear that "$ref" should also be present in the "manager" complex type value.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

JamesTran-MSFT commented 3 years ago

@Andrew-Webb Thanks for your feedback! I have assigned this issue to the author who will investigate and update as appropriate.

Bellarmine-Head commented 3 years ago

I classify "value" and "$ref" sub-attributes of "manager" being described as being both RECOMMENDED and REQUIRED in different sections of the RFC as an error, and have submitted errata to the RFC authors. This is pending verification. For the time being, seeing as no other attribute or sub-attribute in the RFC is RECOMMENDED, I would choose to view "value" and "$ref" as being REQUIRED.

kenwith commented 3 years ago

Thank you for the feedback in improving the doc. I have added this item to our backlog so that it can be prioritized and worked on as appropriate.

please-close