Browse Source

api.md: add documentation to API endpoint about SCIM group warnings

Updates #8645
Signed-off-by: Jenny Zhang <[email protected]>
Jenny Zhang 2 years ago
parent
commit
907c56c200
1 changed files with 15 additions and 0 deletions
  1. 15 0
      api.md

+ 15 - 0
api.md

@@ -1114,6 +1114,21 @@ Look at the response body to determine whether there was a problem within your A
   }
   ```
 
+If your tailnet has [user and group provisioning](https://tailscale.com/kb/1180/sso-okta-scim/) turned on, we will also warn you about
+any groups that are used in the policy file that are not being synced from SCIM. Explicitly defined groups will not trigger this warning.
+
+```jsonc
+{
+  "message":"warning(s) found",
+  "data":[
+          {
+            "user": "group:[email protected]",
+            "warnings":["group is not syncing from SCIM and will be ignored by rules in the policy file"]
+          }
+        ]
+}
+```
+
 <a href="tailnet-devices"></a>
 
 ## List tailnet devices