Package com.xwiki.azureoauth.rest

Interface EntraIDResource

All Superinterfaces:
org.xwiki.rest.XWikiRestComponent
@Unstable public interface EntraIDResource extends org.xwiki.rest.XWikiRestComponent
Provides the API needed by the server in order to skip the OIDC authenticator.
Since:
2.0
Version:
$Id$

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    syncUsers()
    Sync XWiki users with the users from Entra ID.
    javax.ws.rs.core.Response
    xwikiLogin(String redirectDocument)
    Redirect the user to the XWiki login page, skipping the OIDC authenticator.

  • Method Details

    • xwikiLogin

      javax.ws.rs.core.Response xwikiLogin(String redirectDocument) throws org.xwiki.rest.XWikiRestException
      Redirect the user to the XWiki login page, skipping the OIDC authenticator.
      Parameters:
      redirectDocument - the page where to be redirected after log in.
      Returns:
      status code 303 SEE OTHER and the login link for redirecting.
      Throws:
      org.xwiki.rest.XWikiRestException - if an error occurred while building the redirect URL.

    • syncUsers

      @Unstable javax.ws.rs.core.Response syncUsers() throws org.xwiki.rest.XWikiRestException
      Sync XWiki users with the users from Entra ID.
      Returns:
      status code 201 if a new job has been created, or status code 200 if a job with the same ID already exists
      Throws:
      org.xwiki.rest.XWikiRestException - with status code 401 if the user requesting is missing admin rights, or code 500 if any error occurs
      Since:
      2.1