Skip to content

Update Azure AD configuration doc with notes for synchronization delays #10987

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.

Sign up for GitHub

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

Open
thivindu wants to merge 1 commit into
base: 4.6.0
Choose a base branch
from
+35 −0
Open

Update Azure AD configuration doc with notes for synchronization delays #10987

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions ...urity/key-management/third-party-key-managers/configure-azure-ad-key-manager.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,41 @@ Start the API Manager server and log-in to the Admin portal to configure Azure A
</tr>
</tbody>
</table>

!!! note "Handling Azure Application Synchronization Delays"
This capability is supported only from the U2 levels listed below in APIM products

- wso2am-4.6.0 - U2 level 19
- wso2am-acp-4.6.0 - U2 level 20
- wso2am-universal-gw-4.6.0 - U2 level 19

</br>Due to eventual consistency in Azure, there can be delays when creating Applications and Service Principals.
To mitigate issues caused by these synchronization delays, polling is performed for all Azure creation-related interactions.
The polling behavior can be configured using the Initial Delay and Maximum Waiting Time parameters, which are available in the Connector Configuration section.
These fields are described in the table below.
</br></br>Backoff strategy: The delay between polling attempts is doubled after each retry, up to the given maximum delay.
<table>
<thead>
<tr>
<th>Configuration</th>
<th>Instruction</th>
<th>Default Value</th>
</tr>
</thead>
<tr>
<td>Initial Delay (in ms) for Application Polling</td>
<td>Provide an initial time to wait before starting polling for Azure Application creation</td>
<td>500 ms</td>
</tr>
<tr>
<td>Maximum Waiting Time (in ms) for Application Polling</td>
<td>Provide the maximum time to wait for Azure Application creation</td>
<td>5000 ms</td>
</tr>
<tbody>
</tbody>
</table>

7. Set the **Permissions**:
- **Key Manager Permission**: Permission type for role-based Key Manager restriction.
e.g., `PUBLIC`, `ALLOW`, `DENY` (Optional)
Expand Down