Skip to content

Commit

Permalink
Getting Started: Update OpenID Connect FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
lastzero committed Oct 21, 2024
1 parent 6eddc0d commit 8becb59
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/developer-guide/api/oidc.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,5 +173,13 @@ For security reasons, our [Personal Editions](https://www.photoprism.app/edition

[Learn more ›](../../getting-started/advanced/openid-connect.md#frequently-asked-questions)

### Can I configure a custom claim for the preferred username?

You can choose between `preferred_username`, `name`, `nickname` and `email`, where `preferred_username` is the default. The other options are used as a fallback if no value is returned for the [configured claim](#config-options).

Note that it is not possible to use a [non-standard claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) such as `username`, as this could lead to conflicts and potential security issues, e.g. if the value is not unique or not reliably set.

[Learn more ›](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)

[^1]: `PHOTOPRISM_OIDC_REGISTER` must be set to `"true"` to allow new users to create an account
[^2]: Admins cannot change the authentication of their own user account through the [Admin Web UI](../../user-guide/users/index.md#editing-user-details) so that they do not accidentally lock themselves out e.g. by setting it to *None*.
8 changes: 8 additions & 0 deletions docs/getting-started/advanced/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,5 +109,13 @@ Please note in this context that using an external [Identity Provider](#identity
- https://www.microsoft.com/en-us/security/blog/2024/07/29/ransomware-operators-exploit-esxi-hypervisor-vulnerability-for-mass-encryption/
- https://support.broadcom.com/web/ecx/support-content-notification/-/external/content/SecurityAdvisories/0/24505

### Can I configure a custom claim for the preferred username?

You can choose between `preferred_username`, `name`, `nickname` and `email`, where `preferred_username` is the default. The other options are used as a fallback if no value is returned for the [configured claim](#config-options).

Note that it is not possible to use a [non-standard claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) such as `username`, as this could lead to conflicts and potential security issues, e.g. if the value is not unique or not reliably set.

[Learn more ›](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)

[^1]: `PHOTOPRISM_OIDC_REGISTER` must be set to `"true"` to allow new users to create an account
[^2]: Admins cannot change the authentication of their own user account through the [Admin Web UI](../../user-guide/users/index.md#editing-user-details) so that they do not accidentally lock themselves out e.g. by setting it to *None*.
6 changes: 6 additions & 0 deletions docs/getting-started/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,6 +510,12 @@ For security reasons, our [Personal Editions](https://www.photoprism.app/edition

[Learn more ›](advanced/openid-connect.md#frequently-asked-questions)

### Can I configure a custom claim as the preferred OIDC username?

It is not possible to use a [non-standard claim](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims) name such as `username`, as this can lead to conflicts and potential security issues, e.g. if the value is not unique or not reliably set.

[Learn more ›](advanced/openid-connect.md#frequently-asked-questions)

### Who can I contact if I have a complaint about your software?

Please read this documentation and [determine the cause of your problem](https://docs.photoprism.app/getting-started/troubleshooting/) before opening [invalid, duplicate and/or incomplete bug reports](https://web.photoprism.app/kb/reporting-bugs), starting a public "shitstorm" or insulting other community members in our forums and chat rooms. Not only is this annoying for everyone, but it also keeps our team from working on features and improvements that our users are waiting for.
Expand Down

0 comments on commit 8becb59

Please sign in to comment.