Skip to content

Commit 23ea431

Browse files
authored
Merge pull request #5599 from HasiniSama/minor-bugs
Fix minor documentation bugs - Outdated Asgardeo image, typo in SSO flow docs, and add MaxUserNameListLength config to docs
2 parents 5a34b8e + 8bd8abb commit 23ea431

File tree

6 files changed

+92
-4
lines changed

6 files changed

+92
-4
lines changed
-389 KB
Loading

en/identity-server/6.1.0/docs/deploy/performance/performance-tuning-recommendations.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,4 +326,25 @@ pooling for LDAPS connections at the time of starting your server:
326326
-Dcom.sun.jndi.ldap.connect.pool.protocol=ssl
327327
```
328328

329-
4. Start the server.
329+
4. Start the server.
330+
331+
## SCIM2 roles pagination
332+
333+
When retrieving roles from the SCIM2/Roles endpoint, WSO2 Identity Server returns all users assigned to each role by default. For roles containing many users, this can lead to performance bottlenecks and block processing threads.
334+
335+
To optimize performance and prevent thread blocking issues, configure the max users returned per role.
336+
337+
```toml
338+
[pagination]
339+
max_users_list_per_role = <NUMBER_OF_USERS>
340+
```
341+
342+
**Configuration details:**
343+
344+
- **Default value**: 1000 users per role (when not configured)
345+
- **Lowest value**: 1000 users (values below 1000 automatically default to 1000)
346+
- **Scope**: Applies to all roles, including the built-in `everyone` role
347+
- **Database dependency**: Adjust this value based on your database performance capabilities
348+
349+
!!! tip
350+
Check database performance when roles have many users. Start with the default value and adjust based on your environment's capacity.

en/identity-server/7.0.0/docs/deploy/performance/performance-tuning-recommendations.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,4 +235,25 @@ Connection pooling does not apply to LDAPS connections (SSL-enabled LDAP connect
235235
-Dcom.sun.jndi.ldap.connect.pool.protocol=ssl
236236
```
237237
238-
4. Start the server.
238+
4. Start the server.
239+
240+
## SCIM2 roles pagination
241+
242+
When retrieving roles from the SCIM2/Roles endpoint, WSO2 Identity Server returns all users assigned to each role by default. For roles containing many users, this can lead to performance bottlenecks and block processing threads.
243+
244+
To optimize performance and prevent thread blocking issues, configure the max users returned per role.
245+
246+
```toml
247+
[pagination]
248+
max_users_list_per_role = <NUMBER_OF_USERS>
249+
```
250+
251+
**Configuration details:**
252+
253+
- **Default value**: 1000 users per role (when not configured)
254+
- **Lowest value**: 1000 users (values below 1000 automatically default to 1000)
255+
- **Scope**: Applies to all roles, including the built-in `everyone` role
256+
- **Database dependency**: Adjust this value based on your database performance capabilities
257+
258+
!!! tip
259+
Check database performance when roles have many users. Start with the default value and adjust based on your environment's capacity.

en/identity-server/7.1.0/docs/deploy/performance/performance-tuning-recommendations.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,4 +235,25 @@ Connection pooling does not apply to LDAPS connections (SSL-enabled LDAP connect
235235
-Dcom.sun.jndi.ldap.connect.pool.protocol=ssl
236236
```
237237
238-
4. Start the server.
238+
4. Start the server.
239+
240+
## SCIM2 roles pagination
241+
242+
When retrieving roles from the SCIM2/Roles endpoint, WSO2 Identity Server returns all users assigned to each role by default. For roles containing many users, this can lead to performance bottlenecks and block processing threads.
243+
244+
To optimize performance and prevent thread blocking issues, configure the max users returned per role.
245+
246+
```toml
247+
[pagination]
248+
max_users_list_per_role = <NUMBER_OF_USERS>
249+
```
250+
251+
**Configuration details:**
252+
253+
- **Default value**: 1000 users per role (when not configured)
254+
- **Lowest value**: 1000 users (values below 1000 automatically default to 1000)
255+
- **Scope**: Applies to all roles, including the built-in `everyone` role
256+
- **Database dependency**: Adjust this value based on your database performance capabilities
257+
258+
!!! tip
259+
Check database performance when roles have many users. Start with the default value and adjust based on your environment's capacity.

en/identity-server/next/docs/deploy/performance/performance-tuning-recommendations.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,4 +235,25 @@ Connection pooling does not apply to LDAPS connections (SSL-enabled LDAP connect
235235
-Dcom.sun.jndi.ldap.connect.pool.protocol=ssl
236236
```
237237
238-
4. Start the server.
238+
4. Start the server.
239+
240+
## SCIM2 roles pagination
241+
242+
When retrieving roles from the SCIM2/Roles endpoint, WSO2 Identity Server returns all users assigned to each role by default. For roles containing many users, this can lead to performance bottlenecks and block processing threads.
243+
244+
To optimize performance and prevent thread blocking issues, configure the max users returned per role.
245+
246+
```toml
247+
[pagination]
248+
max_users_list_per_role = <NUMBER_OF_USERS>
249+
```
250+
251+
**Configuration details:**
252+
253+
- **Default value**: 1000 users per role (when not configured)
254+
- **Lowest value**: 1000 users (values below 1000 automatically default to 1000)
255+
- **Scope**: Applies to all roles, including the built-in `everyone` role
256+
- **Database dependency**: Adjust this value based on your database performance capabilities
257+
258+
!!! tip
259+
Check database performance when roles have many users. Start with the default value and adjust based on your environment's capacity.

en/includes/guides/organization-management/try-a-b2b-use-case-pet-care.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,11 @@ Follow the steps below to see how organization login works for a user in the **H
541541

542542
3. Click **Sign In with SSO** to specify the organization to which you are signing in.
543543

544+
{% if product_name == "WSO2 Identity Server" and is_version > "7.1.0" %}
545+
4. Enter the **Organization Handle** of the organization and click **Submit**.
546+
{% else %}
544547
4. Enter **Happy Tails** as the organization name and click **Submit**.
548+
{% endif %}
545549

546550
![Sign in with SSO]({{base_path}}/assets/img/guides/organization/manage-organizations/sign-in-with-sso.png){: width="400" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
547551

0 commit comments

Comments
 (0)