Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuring a Read-Write LDAP User Store doc issues #8439

Closed
YasasRangika opened this issue Oct 3, 2024 · 3 comments · Fixed by #8630 or #8634
Closed

Configuring a Read-Write LDAP User Store doc issues #8439

YasasRangika opened this issue Oct 3, 2024 · 3 comments · Fixed by #8630 or #8634
Assignees

Comments

@YasasRangika
Copy link
Contributor

Description

  1. The information in the Info box is not very clear. When I first read the document, I got the impression that the APIM 4.4.0 pack comes with built-in LDAP support. Afterward, I discovered that APIM 4.4.0 pack does not have in-built LDAP support, and we need to have a WSO2 Identity Server product running to utilize LDAP. It's important to note that in-built LDAP support has been removed after Identity Server 5.11 version. For testing purposes, it's best to mention that to use LDAP, you just need to start IS-5.11 pack with port offset=1. Then, the provided configurations should also match (i.e. ConnectionURL="ldap://localhost:10390").
image
  1. In Step 1 [1], configuring the settings in deployment.toml for IS LDAP can be confusing for first-time users.
[user_store]
class="org.wso2.carbon.user.core.ldap.ReadWriteLDAPUserStoreManager"
type = "database"

If you are using the WSO2 Identity Server (WSO2IS) with LDAP, you should refer to the user-mgt.xml file in the <WSO2IS_HOME>/repository/conf directory to find the value for the class key. This time, the default value for the 'type' will be 'database_unique_id', which is included in the package.

  1. The last point of the 5th step in [1] contains typing errors.

thefollowingcodesnipetinsteadofthe > the following code snipet instead of the

[1] https://apim.docs.wso2.com/en/4.4.0/administer/managing-users-and-roles/managing-user-stores/configure-primary-user-store/configuring-a-read-write-ldap-user-store/#step-1-setting-up-the-read-write-ldap-user-store-manager

@RusJaI
Copy link
Contributor

RusJaI commented Oct 30, 2024

Update [2024-10-30]

As per a discussion with IS team following details were identified :

With the above findings, it was decided to provide a template to configure an LDAP rather directly providing config values
and to rewrite the doc as much as possible from scratch.

RusJaI added a commit to RusJaI/docs-apim that referenced this issue Oct 31, 2024
@RusJaI
Copy link
Contributor

RusJaI commented Oct 31, 2024

Update [2024-10-31]

PR was added for 4.4.0 branch

But further identified that there are some ambiguous facts that need to be verified from IS team. Hence keeping this on-hold until getting their input

RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
(cherry picked from commit c9a8329)
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
(cherry picked from commit c9a8329)
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
(cherry picked from commit c9a8329)
@RusJaI
Copy link
Contributor

RusJaI commented Nov 1, 2024

Update [2024-11-01]

Merged the PR for 4.4.0.
Note : Read-write LDAP documentation of IS 6.0.0 and 6.1.0 are identical at the moment. In 7.0.0 they've moved the properties tables into a new page while maintaining the same set of properties. According to the compatibility matrix, APIM 4.4. is fully supported by IS 6.1.0 and 6.0.0. Hence adding the same documentation in IS 6.1.0 to APIM 4.4. and master branch.
Screenshot 2024-11-01 at 17 54 22

Added the PRs for other 4.x versions.

Please find the List of PRs :
4.4.0 : #8601, #8635
4.3.0 : #8631
4.2.0: #8620

Master : #8630

Note : Since APIM 4.0.0 and 4.1.0 supports IS 5.11.0 which has the inbuilt read write LDAP, the documentation have to be modified accordingly.

4.1.0 : #8634
4.0.0: #8636

There are some broken doc links in primary user store main page of APIM 4.3.0 onwards.
4.4.0 : #8638
Added the fix in the previously added PRs for other applicable versions

RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
RusJaI added a commit to RusJaI/docs-apim that referenced this issue Nov 1, 2024
Tharanidk pushed a commit to Tharanidk/docs-apim that referenced this issue Nov 26, 2024
(cherry picked from commit c9a8329)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants