prosody-modules
73c3d5bfce3e
mod_compat_roles/README.markdown
Software / code / prosody-modules
File
mod_compat_roles/README.markdown @ 5666:73c3d5bfce3e
mod_http_oauth2: Allow 'login_hint' as a substitute for OIDC 'select_account' prompt
If the OIDC 'prompt' parameter does not contain the 'select_account'
then it wants us to skip account selection, which means we have to
figure which account to authenticate somehow. One way could be have
this stored in a cookie from a previous successful login. Another way
would be to have the account passed as a hint, which is what we add
here.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sat, 09 Sep 2023 21:42:24 +0200 |
| parent | 4984:fc6a618bfe4e |
line wrap: on
line source
--- labels: - Stage-Alpha summary: Compatibility layer for Prosody's future roles API --- Introduction ============ This module provides compatibility with Prosody's new role and permissions system. It aims to run on Prosody 0.11 and 0.12, providing a limited version of the new API backed by is_admin() (which is not going to be present in trunk and future Prosody versions). It is designed for use by modules which want to be compatible with Prosody versions with and without the new permissions API. Configuration ============= There is no configuration. Usage (for developers) ====================== If you are a module developer, and want your module to work with Prosody trunk and future releases, you should avoid the `usermanager.is_admin()` function. Instead, depend on this module: ``` module:depends("compat_roles") ``` Then use `module:may()` instead: ``` if module:may(":do-something") then -- Blah end ``` For more information on the new role/permissions API, check Prosody's developer documentation at https://prosody.im/doc/developers/permissions Compatibility ============= Requires Prosody 0.11 or 0.12.
