java.lang.Object
- com.azure.spring.autoconfigure.aad.AADAuthenticationProperties

All Implemented Interfaces:: org.springframework.beans.factory.InitializingBean

@Validated
@ConfigurationProperties("azure.activedirectory")
public class AADAuthenticationProperties
extends Object
implements org.springframework.beans.factory.InitializingBean

Configuration properties for Azure Active Directory Authentication.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AADAuthenticationProperties.UserGroupProperties`	Properties dedicated to changing the behavior of how the groups are mapped from the Azure AD response.

Constructor Summary

Constructors
Constructor Description

AADAuthenticationProperties()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`afterPropertiesSet()`
`boolean`	`allowedGroupIdsConfigured()`	Whether allowed group IDs is configured.
`boolean`	`allowedGroupNamesConfigured()`	Whether allowed group names is configured.
`List<String>`	`getActiveDirectoryGroups()`	Gets the list of Active Directory groups.
`String`	`getAppIdUri()`	Gets the App ID URI.
`AADApplicationType`	`getApplicationType()`	Gets the AADApplicationType.
`Map<String,Object>`	`getAuthenticateAdditionalParameters()`	Gets the additional authenticate parameters.
`Map<String,AuthorizationClientProperties>`	`getAuthorizationClients()`	Gets the authorization clients.
`String`	`getBaseUri()`	Gets the base URI.
`String`	`getClientId()`	Gets the client ID.
`String`	`getClientSecret()`	Gets the client secret.
`String`	`getGraphBaseUri()`	Gets the graph base URI.
`String`	`getGraphMembershipUri()`	Gets the graph membership URI.
`long`	`getJwkSetCacheLifespan()`	Gets the JWK set cache lifespan.
`long`	`getJwkSetCacheRefreshTime()`	Gets the JWK set cache refresh time.
`int`	`getJwtConnectTimeout()`	Gets the JWT connect timeout.
`int`	`getJwtReadTimeout()`	Gets the JWT read timeout.
`int`	`getJwtSizeLimit()`	Gets the JWT size limit.
`String`	`getPostLogoutRedirectUri()`	Gets the post logout redirect URI.
`String`	`getRedirectUriTemplate()`	Gets the redirect URI template.
`Boolean`	`getSessionStateless()`	Whether the session is stateless.
`String`	`getTenantId()`	Gets the tenant ID.
`AADAuthenticationProperties.UserGroupProperties`	`getUserGroup()`	Gets the user group properties.
`String`	`getUserNameAttribute()`	Gets the username attribute.
`boolean`	`isAllowedGroup(String group)`	Whether the group is allowed.
`boolean`	`isAllowTelemetry()`	Deprecated. Determined by HTTP header User-Agent instead
`void`	`setActiveDirectoryGroups(List<String> activeDirectoryGroups)`	Deprecated. deprecated
`void`	`setAllowTelemetry(boolean allowTelemetry)`	Sets whether telemetry is allowed.
`void`	`setAppIdUri(String appIdUri)`	Sets the App ID URI.
`void`	`setApplicationType(AADApplicationType applicationType)`	Sets the AADApplicationType.
`void`	`setAuthenticateAdditionalParameters(Map<String,Object> authenticateAdditionalParameters)`	Sets the additional authenticate parameters.
`void`	`setAuthorizationClients(Map<String,AuthorizationClientProperties> authorizationClients)`	Sets the authorization clients.
`void`	`setBaseUri(String baseUri)`	Sets the base URI.
`void`	`setClientId(String clientId)`	Sets the client ID.
`void`	`setClientSecret(String clientSecret)`	Sets the client secret.
`void`	`setGraphBaseUri(String graphBaseUri)`	Sets the graph base URI.
`void`	`setGraphMembershipUri(String graphMembershipUri)`	Sets the graph membership URI.
`void`	`setJwkSetCacheLifespan(long jwkSetCacheLifespan)`	Sets the JWK set cache lifespan.
`void`	`setJwkSetCacheRefreshTime(long jwkSetCacheRefreshTime)`	Sets the JWK set cache refresh time.
`void`	`setJwtConnectTimeout(int jwtConnectTimeout)`	Sets the JWT connect timeout.
`void`	`setJwtReadTimeout(int jwtReadTimeout)`	Sets the JWT read timeout.
`void`	`setJwtSizeLimit(int jwtSizeLimit)`	Sets the JWT size limit.
`void`	`setPostLogoutRedirectUri(String postLogoutRedirectUri)`	Set the post logout redirect URI.
`void`	`setRedirectUriTemplate(String redirectUriTemplate)`	Sets the redirect URI template.
`void`	`setSessionStateless(Boolean sessionStateless)`	Sets whether the session is stateless.
`void`	`setTenantId(String tenantId)`	Sets the tenant ID.
`void`	`setUserGroup(AADAuthenticationProperties.UserGroupProperties userGroup)`	Sets the user group properties.
`void`	`setUserNameAttribute(String userNameAttribute)`	Sets the username attribute.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AADAuthenticationProperties
```
public AADAuthenticationProperties()
```
- Method Detail
  - getApplicationType
```
public AADApplicationType getApplicationType()
```
    Gets the AADApplicationType.
    
    Returns:
    
    the AADApplicationType
  - setApplicationType
```
public void setApplicationType(AADApplicationType applicationType)
```
    Sets the AADApplicationType.
    
    Parameters:
    
    applicationType - the AADApplicationType
  - getActiveDirectoryGroups
```
@DeprecatedConfigurationProperty(reason="Configuration moved to UserGroup class to keep UserGroup properties together",
                                 replacement="azure.activedirectory.user-group.allowed-group-names")
public List<String> getActiveDirectoryGroups()
```
    Gets the list of Active Directory groups.
    
    Returns:
    
    the list of Active Directory groups
  - allowedGroupNamesConfigured
```
public boolean allowedGroupNamesConfigured()
```
    Whether allowed group names is configured.
    
    Returns:
    
    whether allowed group names is configured
  - allowedGroupIdsConfigured
```
public boolean allowedGroupIdsConfigured()
```
    Whether allowed group IDs is configured.
    
    Returns:
    
    whether allowed group IDs is configured
  - getUserGroup
```
public AADAuthenticationProperties.UserGroupProperties getUserGroup()
```
    Gets the user group properties.
    
    Returns:
    
    the user group properties
  - setUserGroup
```
public void setUserGroup(AADAuthenticationProperties.UserGroupProperties userGroup)
```
    Sets the user group properties.
    
    Parameters:
    
    userGroup - the user group properties
  - getClientId
```
public String getClientId()
```
    Gets the client ID.
    
    Returns:
    
    the client ID
  - setClientId
```
public void setClientId(String clientId)
```
    Sets the client ID.
    
    Parameters:
    
    clientId - the client ID
  - getClientSecret
```
public String getClientSecret()
```
    Gets the client secret.
    
    Returns:
    
    the client secret
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    Sets the client secret.
    
    Parameters:
    
    clientSecret - the client secret
  - getUserNameAttribute
```
public String getUserNameAttribute()
```
    Gets the username attribute.
    
    Returns:
    
    the username attribute
  - setUserNameAttribute
```
public void setUserNameAttribute(String userNameAttribute)
```
    Sets the username attribute.
    
    Parameters:
    
    userNameAttribute - the username attribute
  - getRedirectUriTemplate
```
public String getRedirectUriTemplate()
```
    Gets the redirect URI template.
    
    Returns:
    
    the redirect URI template
  - setRedirectUriTemplate
```
public void setRedirectUriTemplate(String redirectUriTemplate)
```
    Sets the redirect URI template.
    
    Parameters:
    
    redirectUriTemplate - the redirect URI template
  - setActiveDirectoryGroups
```
@Deprecated
public void setActiveDirectoryGroups(List<String> activeDirectoryGroups)
```
    Deprecated.
    deprecated
    
    Sets the list of Active Directory groups.
    
    Parameters:
    
    activeDirectoryGroups - the list of Active Directory groups
  - getAppIdUri
```
public String getAppIdUri()
```
    Gets the App ID URI.
    
    Returns:
    
    the App ID URI
  - setAppIdUri
```
public void setAppIdUri(String appIdUri)
```
    Sets the App ID URI.
    
    Parameters:
    
    appIdUri - the App ID URI
  - getAuthenticateAdditionalParameters
```
public Map<String,Object> getAuthenticateAdditionalParameters()
```
    Gets the additional authenticate parameters.
    
    Returns:
    
    the additional authenticate parameters
  - setAuthenticateAdditionalParameters
```
public void setAuthenticateAdditionalParameters(Map<String,Object> authenticateAdditionalParameters)
```
    Sets the additional authenticate parameters.
    
    Parameters:
    
    authenticateAdditionalParameters - the additional authenticate parameters
  - getJwtConnectTimeout
```
public int getJwtConnectTimeout()
```
    Gets the JWT connect timeout.
    
    Returns:
    
    the JWT connect timeout
  - setJwtConnectTimeout
```
public void setJwtConnectTimeout(int jwtConnectTimeout)
```
    Sets the JWT connect timeout.
    
    Parameters:
    
    jwtConnectTimeout - the JWT connect timeout
  - getJwtReadTimeout
```
public int getJwtReadTimeout()
```
    Gets the JWT read timeout.
    
    Returns:
    
    the JWT read timeout
  - setJwtReadTimeout
```
public void setJwtReadTimeout(int jwtReadTimeout)
```
    Sets the JWT read timeout.
    
    Parameters:
    
    jwtReadTimeout - the JWT read timeout
  - getJwtSizeLimit
```
public int getJwtSizeLimit()
```
    Gets the JWT size limit.
    
    Returns:
    
    the JWT size limit
  - setJwtSizeLimit
```
public void setJwtSizeLimit(int jwtSizeLimit)
```
    Sets the JWT size limit.
    
    Parameters:
    
    jwtSizeLimit - the JWT size limit
  - getJwkSetCacheLifespan
```
public long getJwkSetCacheLifespan()
```
    Gets the JWK set cache lifespan.
    
    Returns:
    
    the JWK set cache lifespan
  - setJwkSetCacheLifespan
```
public void setJwkSetCacheLifespan(long jwkSetCacheLifespan)
```
    Sets the JWK set cache lifespan.
    
    Parameters:
    
    jwkSetCacheLifespan - the JWT set cache lifespan
  - getJwkSetCacheRefreshTime
```
public long getJwkSetCacheRefreshTime()
```
    Gets the JWK set cache refresh time.
    
    Returns:
    
    the JWK set cache refresh time
  - setJwkSetCacheRefreshTime
```
public void setJwkSetCacheRefreshTime(long jwkSetCacheRefreshTime)
```
    Sets the JWK set cache refresh time.
    
    Parameters:
    
    jwkSetCacheRefreshTime - the JWK set cache refresh time
  - getTenantId
```
public String getTenantId()
```
    Gets the tenant ID.
    
    Returns:
    
    the tenant ID
  - setTenantId
```
public void setTenantId(String tenantId)
```
    Sets the tenant ID.
    
    Parameters:
    
    tenantId - the tenant ID
  - getPostLogoutRedirectUri
```
public String getPostLogoutRedirectUri()
```
    Gets the post logout redirect URI.
    
    Returns:
    
    the post logout redirect URI
  - setPostLogoutRedirectUri
```
public void setPostLogoutRedirectUri(String postLogoutRedirectUri)
```
    Set the post logout redirect URI.
    
    Parameters:
    
    postLogoutRedirectUri - the post logout redirect URI
  - isAllowTelemetry
```
@Deprecated
@DeprecatedConfigurationProperty(reason="Deprecate the telemetry endpoint and use HTTP header User Agent instead.")
public boolean isAllowTelemetry()
```
    Deprecated.
    Determined by HTTP header User-Agent instead
    
    Whether telemetry is allowed.
    
    Returns:
    
    whether telemetry is allowed
  - setAllowTelemetry
```
public void setAllowTelemetry(boolean allowTelemetry)
```
    Sets whether telemetry is allowed.
    
    Parameters:
    
    allowTelemetry - whether telemetry is allowed
  - getSessionStateless
```
public Boolean getSessionStateless()
```
    Whether the session is stateless.
    
    Returns:
    
    whether the session is stateless
  - setSessionStateless
```
public void setSessionStateless(Boolean sessionStateless)
```
    Sets whether the session is stateless.
    
    Parameters:
    
    sessionStateless - whether the session is stateless
  - getBaseUri
```
public String getBaseUri()
```
    Gets the base URI.
    
    Returns:
    
    the base URI
  - setBaseUri
```
public void setBaseUri(String baseUri)
```
    Sets the base URI.
    
    Parameters:
    
    baseUri - the base URI
  - getGraphBaseUri
```
public String getGraphBaseUri()
```
    Gets the graph base URI.
    
    Returns:
    
    the graph base URI
  - setGraphBaseUri
```
public void setGraphBaseUri(String graphBaseUri)
```
    Sets the graph base URI.
    
    Parameters:
    
    graphBaseUri - the graph base URI
  - getGraphMembershipUri
```
public String getGraphMembershipUri()
```
    Gets the graph membership URI.
    
    Returns:
    
    the graph membership URI
  - setGraphMembershipUri
```
public void setGraphMembershipUri(String graphMembershipUri)
```
    Sets the graph membership URI.
    
    Parameters:
    
    graphMembershipUri - the graph membership URI
  - getAuthorizationClients
```
public Map<String,AuthorizationClientProperties> getAuthorizationClients()
```
    Gets the authorization clients.
    
    Returns:
    
    the authorization clients
  - setAuthorizationClients
```
public void setAuthorizationClients(Map<String,AuthorizationClientProperties> authorizationClients)
```
    Sets the authorization clients.
    
    Parameters:
    
    authorizationClients - the authorization clients
  - isAllowedGroup
```
public boolean isAllowedGroup(String group)
```
    Whether the group is allowed.
    
    Parameters:
    
    group - the group
    
    Returns:
    
    whether the group is allowed
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Class AADAuthenticationProperties

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AADAuthenticationProperties

Method Detail

getApplicationType

setApplicationType

getActiveDirectoryGroups

allowedGroupNamesConfigured

allowedGroupIdsConfigured

getUserGroup

setUserGroup

getClientId

setClientId

getClientSecret

setClientSecret

getUserNameAttribute

setUserNameAttribute

getRedirectUriTemplate

setRedirectUriTemplate

setActiveDirectoryGroups

getAppIdUri

setAppIdUri

getAuthenticateAdditionalParameters

setAuthenticateAdditionalParameters

getJwtConnectTimeout

setJwtConnectTimeout

getJwtReadTimeout

setJwtReadTimeout

getJwtSizeLimit

setJwtSizeLimit

getJwkSetCacheLifespan

setJwkSetCacheLifespan

getJwkSetCacheRefreshTime

setJwkSetCacheRefreshTime

getTenantId

setTenantId

getPostLogoutRedirectUri

setPostLogoutRedirectUri

isAllowTelemetry

setAllowTelemetry

getSessionStateless

setSessionStateless

getBaseUri

setBaseUri

getGraphBaseUri

setGraphBaseUri

getGraphMembershipUri

setGraphMembershipUri

getAuthorizationClients

setAuthorizationClients

isAllowedGroup

afterPropertiesSet