Interface EntraIDConfiguration
@Role
@Unstable
public interface EntraIDConfiguration
Extends
AzureOldConfiguration and adds additional endpoints for the OIDC configuration.- Since:
- 2.0
- Version:
- $Id$
-
Method Summary
Modifier and TypeMethodDescriptionReturn the client ID.Extract the tenant ID from the OIDC Client Configuration.getScope()Return the provider scope.Return the authentication secret.Return the tenant ID.Get the token endpoint saved in the OIDC configuration.Get the user groups that are allowed to log in with XWiki.booleanisActive()See if the provider configuration is active.booleanCheck if XWiki log in is enabled for guest users.voidsetEntraIDConfiguration(Map<String, Object> properties) Set the configuration for the Entra ID class.voidsetOIDCConfiguration(Map<String, Object> properties) Set the configuration for the OIDC class.
-
Method Details
-
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:
trueif the configuration is active, orfalseotherwise.
-
setOIDCConfiguration
void setOIDCConfiguration(Map<String, Object> properties) throws org.xwiki.configuration.ConfigurationSaveExceptionSet the configuration for the OIDC class.- Parameters:
properties-Mapcontaining 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.ConfigurationSaveExceptionSet the configuration for the Entra ID class.- Parameters:
properties-Mapcontaining 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:
trueif global log in is enabled andfalseotherwise.
-
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
Get the token endpoint saved in the OIDC configuration.- Returns:
- the configured token endpoint.
- Since:
- 2.1
-