Mercurial > prosody-modules
view mod_compat_roles/README.markdown @ 5228:77cd01af06a9
mod_http_oauth2: Implement the OpenID userinfo endpoint
Needed for OIDC
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 09 Mar 2023 14:46:06 +0100 |
parents | fc6a618bfe4e |
children |
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.