Merge pull request #5797 from himeshsiriwardana/federated-scim-access

Author: himeshsiriwardana

en/identity-server/5.10.0/docs/develop/restapis/scim2.yaml

@@ -5,6 +5,15 @@ info:
   description: |
     SCIM 2.0 endpoints
     It is written with [swagger 2](http://swagger.io/).
+
+    <div style="border-left: 4px solid #f0ad4e; padding: 8px 12px; margin: 12px 0; background-color: #fcf8e3;">
+        <strong>Note:</strong> To prevent federated users from accessing the <code>Me</code> endpoint,
+        set the following property to <code>true</code> in
+        <code>&lt;IS_HOME&gt;/repository/conf/deployment.toml</code>.
+        <pre><code>[scim2]
+    restrict_federated_user_access_to_me_endpoint = true
+        </code></pre>
+        </div>
   contact:
     name: WSO2 Identity Server Team
     url: 'http://wso2.com'

en/identity-server/5.10.0/docs/develop/scim-1.1-apis.md

@@ -9,7 +9,15 @@
         SCIM 1.1 APIs (e.g., additional search filters for filtering users).
     -   The SCIM 2.0 schema supports more fine-grained requirements.  
     -   There is more focus on feature development for SCIM 2.0 APIs.
+
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+    To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
 
+    ```toml
+    [scim]
+    restrict_federated_user_access = true
+    ```
 
 The SCIM API can be called in order to perform various tasks in the WSO2
 Identity Server. For simplicity, cURL commands are used in this example

en/identity-server/5.11.0/docs/develop/restapis/scim2.yaml

@@ -5,6 +5,15 @@ info:
   description: |
     SCIM 2.0 endpoints
     It is written with [swagger 2](http://swagger.io/).
+
+    <div style="border-left: 4px solid #f0ad4e; padding: 8px 12px; margin: 12px 0; background-color: #fcf8e3;">
+        <strong>Note:</strong> To prevent federated users from accessing the <code>Me</code> endpoint,
+        set the following property to <code>true</code> in
+        <code>&lt;IS_HOME&gt;/repository/conf/deployment.toml</code>.
+        <pre><code>[scim2]
+    restrict_federated_user_access_to_me_endpoint = true
+        </code></pre>
+        </div>
   contact:
     name: WSO2 Identity Server Team
     url: 'http://wso2.com'

en/identity-server/5.11.0/docs/develop/scim-1.1-apis.md

@@ -9,7 +9,15 @@
         SCIM 1.1 APIs (e.g., additional search filters for filtering users).
     -   The SCIM 2.0 schema supports more fine-grained requirements.  
     -   There is more focus on feature development for SCIM 2.0 APIs.
+
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+    To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
 
+    ```toml
+    [scim]
+    restrict_federated_user_access = true
+    ```
 
 The SCIM API can be called in order to perform various tasks in the WSO2
 Identity Server. For simplicity, cURL commands are used in this example

en/identity-server/5.9.0/docs/develop/scim-1.1-apis.md

@@ -9,8 +9,16 @@
         SCIM 1.1 APIs (e.g., additional search filters for filtering users).
     -   The SCIM 2.0 schema supports more fine-grained requirements.  
     -   There is more focus on feature development for SCIM 2.0 APIs.
-    
 
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+    To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
+    
+    ```toml
+    [scim]
+    restrict_federated_user_access = true
+    ```
+    
 The SCIM API can be called in order to perform various tasks in the WSO2
 Identity Server. For simplicity, cURL commands are used in this example
 to send CRUD requests to the REST endpoints of Identity Server.

en/identity-server/5.9.0/docs/develop/using-the-scim-2.0-rest-apis.md

@@ -2142,6 +2142,15 @@ All the of the users dialect and meta dialect are supported. For more informatio
 ## Me Endpoint 
 This endpoint is used to create and manage the currently authenticated user. 
 
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+	To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
+	
+	```toml
+	[scim2]
+	restrict_federated_user_access_to_me_endpoint = true
+	```
+
 ### POST/ Create Me
 `POST https://localhost:9443/t/{tenant-domain}/scim2/Me`
 

en/identity-server/6.0.0/docs/apis/scim-1.1-apis.md

@@ -9,7 +9,15 @@
         SCIM 1.1 APIs (e.g., additional search filters for filtering users).
     -   The SCIM 2.0 schema supports more fine-grained requirements.  
     -   There is more focus on feature development for SCIM 2.0 APIs.
+
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+    To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
 
+    ```toml
+    [scim]
+    restrict_federated_user_access = true
+    ``` 
 
 The SCIM API is used in to perform various tasks in the WSO2
 Identity Server. For simplicity, cURL commands are used in this example

en/identity-server/6.1.0/docs/apis/scim-1.1-apis.md

@@ -9,7 +9,15 @@
         SCIM 1.1 APIs (e.g., additional search filters for filtering users).
     -   The SCIM 2.0 schema supports more fine-grained requirements.  
     -   There is more focus on feature development for SCIM 2.0 APIs.
+
+!!! note "Prevent federated users from accessing the Me endpoint"
+
+    To prevent federated users from accessing the Me endpoint, set the following property to true in `<IS_HOME>/repository/conf/deployment.toml` file.
 
+    ```toml
+    [scim]
+    restrict_federated_user_access = true
+    ```
 
 The SCIM API is used in to perform various tasks in the WSO2
 Identity Server. For simplicity, cURL commands are used in this example