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

Updates #8645
Signed-off-by: Jenny Zhang <jz@tailscale.com>
This commit is contained in:
Jenny Zhang 2023-07-20 17:51:46 -04:00 committed by phirework
parent e1bcecc393
commit 907c56c200
1 changed files with 15 additions and 0 deletions

15
api.md
View File

@ -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:unknown@example.com",
"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