fix(docs): add documentation for SCIM screen on Admin-UI

[ossdhaval]

This PR adds documentation for Admin-UI SCIM configuration screen.

Summary of changes:

• Screenshots to the latest release of the Admin UI
• Add description of each input field. Along with some guidelines on the use of that input.

[jgomer2001]

95% of these contents are b*hit ...

• It is unnecessary to provide justifications for every single property, like "...improves performance, and enables efficient pagination...".
• For some reason, AI infers this is LDAP-centric stuff and mentions "directory" all over the place - this does not hold anymore

I think we can focus on a few properties that are useful. For the rest I ignore if they are used, or what they do. Here is my list:

• Base Endpoint
• maxCount
• Bulk Max Operations
• Bulk Max Payload Size
• User Extension Schema URI
• Logging Level
• skipDefinedPasswordValidation

Here, descriptions given are OK, except for their bias towards LDAP. Also account scim in Jans is not only about users and groups

skipDefinedPasswordValidation determines if the the regex defined at the server level for user passwords should be bypassed or not. This is located in the attributes table (row corresponding to password attr)

[ossdhaval]

95% of these contents are b*hit ...

• It is unnecessary to provide justifications for every single property, like "...improves performance, and enables efficient pagination...".
• For some reason, AI infers this is LDAP-centric stuff and mentions "directory" all over the place - this does not hold anymore

I think we can focus on a few properties that are useful. For the rest I ignore if they are used, or what they do. Here is my list:

• Base Endpoint
• maxCount
• Bulk Max Operations
• Bulk Max Payload Size
• User Extension Schema URI
• Logging Level
• skipDefinedPasswordValidation

Here, descriptions given are OK, except for their bias towards LDAP. Also account scim in Jans is not only about users and groups

skipDefinedPasswordValidation determines if the the regex defined at the server level for user passwords should be bypassed or not. This is located in the attributes table (row corresponding to password attr)

Thank you for your honest feedback. AI assisted content generation should be reviewed closely.

Let me remove other properties apart from what you listed above. Then I'll need your help to reword it so that LDAP is not in focus.

[ossdhaval]

95% of these contents are b*hit ...

• It is unnecessary to provide justifications for every single property, like "...improves performance, and enables efficient pagination...".
• For some reason, AI infers this is LDAP-centric stuff and mentions "directory" all over the place - this does not hold anymore

I think we can focus on a few properties that are useful. For the rest I ignore if they are used, or what they do. Here is my list:

• Base Endpoint
• maxCount
• Bulk Max Operations
• Bulk Max Payload Size
• User Extension Schema URI
• Logging Level
• skipDefinedPasswordValidation

Here, descriptions given are OK, except for their bias towards LDAP. Also account scim in Jans is not only about users and groups

skipDefinedPasswordValidation determines if the the regex defined at the server level for user passwords should be bypassed or not. This is located in the attributes table (row corresponding to password attr)

@jgomer2001 I didn't get For the rest I ignore if they are used, or what they do. part of your comment. Can you please elaborate. Are these properties not used?

[jgomer2001]

Probably they are not used. Many of jans apps share the same bootstrapping/initialization code that resides in shared libraries but most of us (devs) are not really familiar with them. It has to do with topics like cache, document store, logging, etc..

Based on past experiences, removing "pointers" to features that are not in use may cause scim not to start properly... So I guess that's why they still remain in the configuration. However, the list I provided contains the set of properties that in practice admins and developers would really like to tweak

[ossdhaval]

I see.

So those not so much used properties are there on the admin UI screen just for technical reasons(shared libs). They don't offer any functional value.

In this case, I have two suggestions:

1. Rearrange the property input fields on the Admin-UI. Show the useful properties by default, hide the unused or infrequently used properties under a section like More configuration which stays collapsed by default. This will simplify the screen and focus stays on what is useful.
2. Remove the unused properties from the screen. Since they are not going to be updated by admins anyway.

Note: If other modules also have the same burden of unused properties on the config screens, this suggestion will apply to those screens as well.

@nynymike @moabu @syntrydy @yurem Please opine.

[ossdhaval]

@jgomer2001 I have removed the details about less-frequently used properties. Can you please update the descriptions of the remaining properties to effect this part of your comment except for their bias towards LDAP. Also account scim in Jans is not only about users and groups.

[sonarqubecloud]

Quality Gate passed for 'Gluu Admin UI'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud