make documentation cleaner
continuous-integration/drone/pr Build is failing
Details
continuous-integration/drone/pr Build is failing
Details
This commit is contained in:
parent
dace429bb7
commit
bd2cb9ad8b
|
@ -304,7 +304,7 @@ auth:
|
|||
# The client secret used to authenticate Vikunja at the OpenID Connect provider.
|
||||
clientsecret:
|
||||
# The scope necessary to use oidc.
|
||||
# If you want to use the Feature to create and assign to vikunja teams via oidc, you have to add the custom "vikunja_scope".
|
||||
# If you want to use the Feature to create and assign to vikunja teams via oidc, you have to add the custom "vikunja_scope" and check [openid.md](https://kolaente.dev/vikunja/api/src/branch/main/pkg/modules/auth/openid/openid.md)
|
||||
# e.g. scope: openid email profile vikunja_scope
|
||||
scope: openid email profile
|
||||
|
||||
|
|
|
@ -1,14 +1,12 @@
|
|||
regarding:
|
||||
https://kolaente.dev/vikunja/api/pulls/1279
|
||||
|
||||
# Assign teams via oidc
|
||||
This PR adds the functionality to assign users to teams via oidc.
|
||||
Read carefully and brief your administrators to use this feature.
|
||||
Tested with oidc provider authentik.
|
||||
To distinguish between groups created in vikunja and groups generated via oidc, there is an attribute neccessary, which is called: *oidcID*
|
||||
To distinguish between teams created in vikunja and teams generated via oidc, an attribute for vikunja teams is introduced, which is called: *oidcID*
|
||||
|
||||
## Setup
|
||||
Edit config.yml to include scope: openid profile email vikunja_scope
|
||||
|
||||
Edit [config.yml](https://kolaente.dev/vikunja/api/src/branch/main/config.yml.sample) to include scope: openid profile email vikunja_scope
|
||||
|
||||
For authentik to use group assignment feature:
|
||||
- go to: .../if/admin/#/core/property-mappings
|
||||
|
@ -51,12 +49,11 @@ You should see "the description you entered in the oidc provider's admin area"
|
|||
|
||||
|
||||
## IMPORTANT NOTES:
|
||||
**SSO/OIDC teams cannot be edited.**
|
||||
* **SSO/OIDC teams cannot be edited.**
|
||||
|
||||
**It is crucial to call the element "vikunja_groups" since this is the name vikunja is looking for.**
|
||||
|
||||
**Additionally, make sure to deliver an "oidcID" and a "name".**
|
||||
* **It is crucial to call the element "vikunja_groups" since this is the name vikunja is looking for.**
|
||||
|
||||
* **Additionally, make sure to deliver an "oidcID" and a "name".**
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue