Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit cdb0890

Browse files
authored
chore: add docs for creating missing groups on oidc sync (coder#8983)
1 parent 370bdd6 commit cdb0890

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/admin/auth.md

+22
Original file line numberDiff line numberDiff line change
@@ -288,6 +288,28 @@ OIDC provider will be added to the `myCoderGroupName` group in Coder.
288288

289289
Some common issues when enabling group sync.
290290

291+
#### User not being assigned / Group does not exist
292+
293+
If you want Coder to create groups that do not exist, you can set the following environment variable. If you enable this, your OIDC provider might be sending over many unnecessary groups. Use filtering options on the OIDC provider to limit the groups sent over to prevent creating excess groups.
294+
295+
```console
296+
# as an environment variable
297+
CODER_OIDC_GROUP_AUTO_CREATE=true
298+
299+
# as a flag
300+
--oidc-group-auto-create=true
301+
```
302+
303+
A basic regex filtering option on the Coder side is available. This is applied **after** the group mapping (`CODER_OIDC_GROUP_MAPPING`), meaning if the group is remapped, the remapped value is tested in the regex. This is useful if you want to filter out groups that do not match a certain pattern. For example, if you want to only allow groups that start with `my-group-` to be created, you can set the following environment variable.
304+
305+
```console
306+
# as an environment variable
307+
CODER_OIDC_GROUP_REGEX_FILTER="^my-group-.*$"
308+
309+
# as a flag
310+
--oidc-group-regex-filter="^my-group-.*$"
311+
```
312+
291313
#### Invalid Scope
292314

293315
If you see an error like the following, you may have an invalid scope.

0 commit comments

Comments
 (0)