Package com.xwiki.azureoauth.user

Interface EntraIDUsersManager

@Role @Unstable public interface EntraIDUsersManager
Expose the EntraID users which are already present on the XWiki instance, or the list which is provided by the EntraID server.
Since:
2.1
Version:
$Id$

  • Method Summary

    Modifier and Type
    Method
    Description
    List<ExternalUser>
    getEntraServerUsers()
    Get a List of users present on the EntraID server.
    List<com.xpn.xwiki.doc.XWikiDocument>
    getXWikiUsers()
    Get a List of internal users that are created from EntraId.
    Map<String,com.xpn.xwiki.doc.XWikiDocument>
    getXWikiUsersMap()
    Get a Map of internal users that are created from EntraId, with the user id (subject) as the key.

  • Method Details

    • getXWikiUsersMap

      Map<String,com.xpn.xwiki.doc.XWikiDocument> getXWikiUsersMap() throws Exception
      Get a Map of internal users that are created from EntraId, with the user id (subject) as the key.
      Returns:
      the internal users that are created from EntraId
      Throws:
      Exception - if there are any errors while getting the users.

    • getXWikiUsers

      List<com.xpn.xwiki.doc.XWikiDocument> getXWikiUsers() throws com.xpn.xwiki.XWikiException, org.xwiki.query.QueryException
      Get a List of internal users that are created from EntraId.
      Returns:
      a List of the user documents
      Throws:
      com.xpn.xwiki.XWikiException - if there is any error while retrieving the documents
      org.xwiki.query.QueryException - if the query execution fails

    • getEntraServerUsers

      List<ExternalUser> getEntraServerUsers() throws Exception
      Get a List of users present on the EntraID server.
      Returns:
      the external users info stored in ExternalUser
      Throws:
      Exception - if there are any errors while getting the users.