-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update properties description according to current doc #43447
Open
v-minh1
wants to merge
7
commits into
Azure:main
Choose a base branch
from
v-minh1:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5acece3
Compare properties description with current doc, update source files
v-minh1 922b13a
Merge branch 'Azure:main' into main
v-minh1 69f2d9b
Merge branch 'Azure:main' into main
v-minh1 246f70a
update properties description according to current doc
v-minh1 ddf33f9
Revert changes to ApplicationInsightsComponentProperties.java
v-minh1 c45c6f1
Revert changes to Configuration.java
v-minh1 63db810
Revert changes to AuthProperty.java
v-minh1 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -78,7 +78,7 @@ public class AadAuthenticationProperties implements InitializingBean { | |
private String redirectUriTemplate = "{baseUrl}/login/oauth2/code/"; | ||
|
||
/** | ||
* App ID URI which might be used in the "aud" claim of an id_token. For instance, 'api://{applicationId}'. | ||
* App ID URI that might be used in the "aud" claim of an `id_token`. For instance, `api://{applicationId}`. | ||
* See Microsoft doc about APP ID URL for more details: https://learn.microsoft.com/azure/active-directory/develop/security-best-practices-for-app-registration#application-id-uri | ||
*/ | ||
private String appIdUri; | ||
|
@@ -111,41 +111,41 @@ public class AadAuthenticationProperties implements InitializingBean { | |
private int jwtSizeLimit = RemoteJWKSet.DEFAULT_HTTP_SIZE_LIMIT; /* bytes */ | ||
|
||
/** | ||
* The lifespan(duration) of the cached JWK set before it expires. The default value is `5m`. | ||
* The lifespan(duration) of the cached JWK set before it expires. | ||
*/ | ||
private Duration jwkSetCacheLifespan = Duration.ofMinutes(5); | ||
|
||
/** | ||
* The refresh time(duration) of the cached JWK set before it expires. The default value is `5m`. | ||
* The refresh time(duration) of the cached JWK set before it expires. | ||
*/ | ||
private Duration jwkSetCacheRefreshTime = Duration.ofMinutes(5); | ||
|
||
/** | ||
* The redirect uri after logout. For instance, 'http://localhost:8080/'. | ||
* The redirect uri after logout. For instance, `http://localhost:8080/`. | ||
* See Microsoft doc about Redirect URI for more details: https://learn.microsoft.com/azure/active-directory/develop/security-best-practices-for-app-registration#redirect-uri | ||
*/ | ||
private String postLogoutRedirectUri; | ||
|
||
/** | ||
* If true activates the stateless auth filter AADAppRoleStatelessAuthenticationFilter. The default is false which | ||
* activates AADAuthenticationFilter. | ||
* If true activates the stateless auth filter `AADAppRoleStatelessAuthenticationFilter`. The default is false, which | ||
* activates `AADAuthenticationFilter`. | ||
*/ | ||
private Boolean sessionStateless = false; | ||
|
||
/** | ||
* The OAuth2 authorization clients, contains the authorization grant type, client authentication method and scope. | ||
* The clients will be converted to OAuth2 ClientRegistration, the other ClientRegistration information(such as client id, client secret) inherits from the delegated OAuth2 login client 'azure'. | ||
* For instance,' | ||
* authorization-clients.webapi.authorization-grant-type=on_behalf_of, | ||
* authorization-clients.webapi.client-authentication-method=client_secret_post, | ||
* authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope1, | ||
* authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope2 | ||
* '. | ||
* The clients will be converted to OAuth2 `ClientRegistration`, the other `ClientRegistration` information(such as client id, client secret) inherits from the delegated OAuth2 login client `azure`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can we implement this in the doc plugin, so we can replace any '' in the comment, to `` |
||
* For instance,` | ||
* authorization-clients.webapi.authorization-grant-type=on_behalf_of`, | ||
* `authorization-clients.webapi.client-authentication-method=client_secret_post`, | ||
* `authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope1`, | ||
* `authorization-clients.webapi.scopes[0]={WEB_API_APP_ID_URL}/WebApi.ExampleScope2` | ||
* . | ||
*/ | ||
private final Map<String, AuthorizationClientProperties> authorizationClients = new HashMap<>(); | ||
|
||
/** | ||
* Type of the Azure AD application. Supported types are: WEB_APPLICATION, RESOURCE_SERVER, RESOURCE_SERVER_WITH_OBO, WEB_APPLICATION_AND_RESOURCE_SERVER. The value can be inferred by dependencies, only 'web_application_and_resource_server' must be configured manually. | ||
* The type of the Microsoft Entra application. Supported types are: `WEB_APPLICATION`, `RESOURCE_SERVER`, `RESOURCE_SERVER_WITH_OBO`, `WEB_APPLICATION_AND_RESOURCE_SERVER`. The value can be inferred by dependencies, only `web_application_and_resource_server` must be configured manually. | ||
*/ | ||
private AadApplicationType applicationType; | ||
|
||
|
@@ -187,17 +187,17 @@ public void setApplicationType(AadApplicationType applicationType) { | |
public static class UserGroupProperties { | ||
|
||
/** | ||
* The group names can be used to construct GrantedAuthority. | ||
* The group names can be used to construct `GrantedAuthority`. | ||
*/ | ||
private List<String> allowedGroupNames = new ArrayList<>(); | ||
|
||
/** | ||
* The group IDs can be used to construct GrantedAuthority. | ||
* The group IDs can be used to construct `GrantedAuthority`. | ||
*/ | ||
private Set<String> allowedGroupIds = new HashSet<>(); | ||
|
||
/** | ||
* Whether to use transitive way to get members. If "true", use "v1.0/me/transitiveMemberOf" to get members. Otherwise, use "v1.0/me/memberOf". The default value is `false`. | ||
* Whether to use transitive way to get members. If `true`, use `v1.0/me/transitiveMemberOf` to get members. Otherwise, use `v1.0/me/memberOf`. | ||
*/ | ||
private boolean useTransitiveMembers = false; | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you help check how the
The default value is
5m`` is auto-generated by the doc plugin?