Package com.xwiki.azureoauth.configuration

Interface EntraIDConfiguration

  • @Role
@Unstable
public interface EntraIDConfiguration
    Extends AzureOldConfiguration and adds additional endpoints for the OIDC configuration.
    Since:
    2.0
    Version:
    $Id$

    • Method Detail

      • getTenantID

        String getTenantID()
        Return the tenant ID.
        Returns:
        the tenant ID.

      • getClientID

        String getClientID()
        Return the client ID.
        Returns:
        the client ID.

      • getSecret

        String getSecret()
        Return the authentication secret.
        Returns:
        the authentication secret.

      • getScope

        String getScope()
        Return the provider scope.
        Returns:
        the provider scope.

      • isActive

        boolean isActive()
        See if the provider configuration is active.
        Returns:
        true if the configuration is active, or false otherwise.

      • setOIDCConfiguration

        void setOIDCConfiguration​(Map<String,​Object> properties)
                   throws org.xwiki.configuration.ConfigurationSaveException
        Set the configuration for the OIDC class.
        Parameters:
        properties - Map containing the properties that will be saved.
        Throws:
        org.xwiki.configuration.ConfigurationSaveException - if any error occurs during configuration save.

      • setEntraIDConfiguration

        void setEntraIDConfiguration​(Map<String,​Object> properties)
                      throws org.xwiki.configuration.ConfigurationSaveException
        Set the configuration for the Entra ID class.
        Parameters:
        properties - Map containing the properties that will be saved.
        Throws:
        org.xwiki.configuration.ConfigurationSaveException - if any error occurs during configuration save.

      • getOIDCTenantID

        String getOIDCTenantID()
        Extract the tenant ID from the OIDC Client Configuration.
        Returns:
        the extracted tenant ID.

      • isXWikiLoginGlobalEnabled

        boolean isXWikiLoginGlobalEnabled()
        Check if XWiki log in is enabled for guest users.
        Returns:
        true if global log in is enabled and false otherwise.

      • getXWikiLoginGroups

        String getXWikiLoginGroups()
        Get the user groups that are allowed to log in with XWiki.
        Returns:
        the user groups that are allowed to log in with XWiki.

      • getTokenEndpoint

        @Unstable
String getTokenEndpoint()
        Get the token endpoint saved in the OIDC configuration.
        Returns:
        the configured token endpoint.
        Since:
        2.1