Skip to content

Commit c797786

Browse files
Merge pull request #5195 from BimsaraBodaragama/internal/3187
Update Microsoft Federated IDP Docs in Older IS Versions to Reflect Current Standards
2 parents a4146ed + 5bbe205 commit c797786

23 files changed

Lines changed: 431 additions & 166 deletions

en/identity-server/5.10.0/docs/develop/using-the-identity-provider-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Permission Level: ` /permission/admin/manage `
347347
<ax2392:properties xsi:type="ax2392:Property">
348348
<ax2392:confidential>true</ax2392:confidential>
349349
<ax2392:defaultValue xsi:nil="true"/>
350-
<ax2392:description>Enter Microsoft Live client secret value</ax2392:description>
350+
<ax2392:description>Enter Microsoft login client secret value</ax2392:description>
351351
<ax2392:displayName>Client Secret</ax2392:displayName>
352352
<ax2392:name>ClientSecret</ax2392:name>
353353
<ax2392:required>true</ax2392:required>
@@ -367,7 +367,7 @@ Permission Level: ` /permission/admin/manage `
367367
<ax2392:properties xsi:type="ax2392:Property">
368368
<ax2392:confidential>false</ax2392:confidential>
369369
<ax2392:defaultValue xsi:nil="true"/>
370-
<ax2392:description>Enter Microsoft Live client identifier value</ax2392:description>
370+
<ax2392:description>Enter Microsoft login client identifier value</ax2392:description>
371371
<ax2392:displayName>Client Id</ax2392:displayName>
372372
<ax2392:name>ClientId</ax2392:name>
373373
<ax2392:required>true</ax2392:required>

en/identity-server/5.10.0/docs/learn/adding-and-configuring-an-identity-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ security realm.
1313

1414
The responsibility of the identity provider configuration is to
1515
represent external identity providers. These external identity providers
16-
can be Facebook, Yahoo, Google, Salesforce, Microsoft Windows Live, etc.
16+
can be Facebook, Yahoo, Google, Salesforce, Microsoft login, etc.
1717
If you want to authenticate users against these identity providers, then
1818
you must associate one or more federated authenticators with the WSO2
1919
Identity Server. These identity providers support for different

en/identity-server/5.10.0/docs/learn/configuring-microsoft-windows-live.md renamed to en/identity-server/5.10.0/docs/learn/configuring-microsoft-login.md

Lines changed: 71 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,74 @@
1-
# Configuring Microsoft Windows Live
1+
# Configuring Microsoft login
22

3-
Microsoft Windows Live can be used as a federated authenticator in the
3+
Microsoft login can be used as a federated authenticator in the
44
Identity Server. Do the following to configure the Identity Server to
5-
authenticate users using their Microsoft Live user accounts.
5+
authenticate users using their Microsoft accounts.
66

7-
!!! tip "Before you begin"
8-
9-
1. [Register an application on Windows
10-
Live](https://msdn.microsoft.com/en-us/library/hh826541.aspx).
11-
2. Sign in to the WSO2 Identity Server [Management
7+
# Configure Microsoft login as a federated authenticator
8+
9+
Microsoft login can be used as a federated authenticator in the
10+
Identity Server.
11+
12+
Follow the steps given below to configure WSO2 Identity Server to
13+
authenticate users with their Microsoft accounts.
14+
15+
## Register WSO2 Identity Server on Microsoft
16+
17+
You need to register WSO2 Identity Server as an OAuth2.0 application on Microsoft Entra ID.
18+
19+
!!! note
20+
For detailed instructions, you can follow the [Microsoft documentation](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app){:target="_blank"}.
21+
22+
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/){:target="_blank"} using an account with administrator permission.
23+
24+
!!! note
25+
You must use an account in the same Microsoft 365 subscription (tenant) with which you intend to register the app.
26+
27+
2. Go to **Identity** > **Applications** > **App registrations** and select **New registration**.
28+
29+
3. Click **Add** and select **App registration** from the list.
30+
31+
4. Provide the required information for app registration.
32+
33+
![Register an application on the Microsoft Entra admin center]({{base_path}}/assets/img/guides/idp/microsoft-idp/register-an-application.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
34+
35+
<table>
36+
<tr>
37+
<th>Parameter</th>
38+
<th>Description</th>
39+
</tr>
40+
<tr>
41+
<td>Name</td>
42+
<td>Enter a meaningful name for your application.</td>
43+
</tr>
44+
<tr>
45+
<td>Supported Account Type</td>
46+
<td>Select the supported account type. <br><b>Value: </b><code>Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g., Skype, Xbox)</code></td>
47+
</tr>
48+
<tr>
49+
<td>Redirect URI</td>
50+
<td>Select <b>Web</b> as the platform and provide the URL to redirect after the login is completed.<br><b>Value:</b> <code>{{product_url_format}}/commonauth</code></td>
51+
</tr>
52+
</table>
53+
54+
5. Click **Register** to create the application.
55+
56+
!!! note
57+
Take note of the client ID after the application is created.
58+
59+
Now, let's generate a client secret for the application.
60+
61+
1. Go to **Certificates & secrets** on the left navigation and click **+ New client secret**.
62+
2. Enter a description for the client secret and select the expiry time.
63+
3. Click **Add** to add the client secret.
64+
65+
!!! note "Important"
66+
Take note of the generated **Value**. Microsoft Entra will allow copying this value only once. This value is the newly generated client secret for your Microsoft connection in WSO2 Identity Server.
67+
68+
69+
!!! tip "Before you register the Microsoft IdP"
70+
71+
1. Sign in to the WSO2 Identity Server [Management
1272
Console](../../setup/getting-started-with-the-management-console)
1373
at ` https://<Server Host>:9443/carbon ` using your
1474
` username ` and ` password ` .
@@ -34,17 +94,15 @@ authenticate users using their Microsoft Live user accounts.
3494

3595
4. Fill in the following fields where relevant.
3696
Prior to configuring, you need to have an application created in
37-
Windows live. See [Configuring your
38-
app](https://msdn.microsoft.com/en-us/library/hh826541.aspx) to
39-
create an application in Windows Live.
97+
Microsoft login.
4098

4199
| Field | Description | Sample value |
42100
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
43101
| Enable | Selecting this option enables Microsoft to be used as an authenticator for users provisioned to the Identity Server. | Selected |
44102
| Default | Selecting the **Default** check box signifies that Microsoft is the main/default form of authentication. This removes the selection made for any other **Default** checkboxes for other authenticators. | Selected |
45-
| Client Secret | This is the password from the Microsoft Live application. Click the **Show** button to view the value you enter. | 12ffb4dfb2fed67a00846b42126991f8 |
103+
| Client Secret | This is the password from the Microsoft login application. Click the **Show** button to view the value you enter. | 12ffb4dfb2fed67a00846b42126991f8 |
46104
| Callback URL | This is the URL to which the browser should be redirected after the authentication is successful. It should have this format: ` https://(host-name):(port)/acs ` | [https://localhost:9443/commonauth](https://www.google.com/url?q=https%3A%2F%2Flocalhost%3A9443%2Fcommonauth&sa=D&sntz=1&usg=AFQjCNG7dB10sZ-F07Du9Q5fT-mVDMfobg) |
47-
| Client Id | This is the username from the Microsoft Live application. | 1421263438188909 |
105+
| Client Id | This is the username from the Microsoft login application. | 1421263438188909 |
48106

49107
!!! info "Related Topics"
50108

en/identity-server/5.10.0/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ nav:
215215
- 'Configuring Facebook': learn/configuring-facebook.md
216216
- 'Configuring Yahoo': learn/configuring-yahoo.md
217217
- 'Configuring Google': learn/configuring-google.md
218-
- 'Configuring Microsoft Windows Live': learn/configuring-microsoft-windows-live.md
218+
- 'Configuring Microsoft login': learn/configuring-microsoft-login.md
219219
- 'Configuring IWA on Linux': learn/configuring-iwa-on-linux.md
220220
- 'Configuring AD FS as a Federated Authenticator': learn/configuring-ad-fs-as-a-federated-authenticator.md
221221
- 'Configuring Twitter': learn/configuring-twitter.md

en/identity-server/5.11.0/docs/develop/using-the-identity-provider-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Permission Level: ` /permission/admin/manage `
347347
<ax2392:properties xsi:type="ax2392:Property">
348348
<ax2392:confidential>true</ax2392:confidential>
349349
<ax2392:defaultValue xsi:nil="true"/>
350-
<ax2392:description>Enter Microsoft Live client secret value</ax2392:description>
350+
<ax2392:description>Enter Microsoft login client secret value</ax2392:description>
351351
<ax2392:displayName>Client Secret</ax2392:displayName>
352352
<ax2392:name>ClientSecret</ax2392:name>
353353
<ax2392:required>true</ax2392:required>
@@ -367,7 +367,7 @@ Permission Level: ` /permission/admin/manage `
367367
<ax2392:properties xsi:type="ax2392:Property">
368368
<ax2392:confidential>false</ax2392:confidential>
369369
<ax2392:defaultValue xsi:nil="true"/>
370-
<ax2392:description>Enter Microsoft Live client identifier value</ax2392:description>
370+
<ax2392:description>Enter Microsoft login client identifier value</ax2392:description>
371371
<ax2392:displayName>Client Id</ax2392:displayName>
372372
<ax2392:name>ClientId</ax2392:name>
373373
<ax2392:required>true</ax2392:required>

en/identity-server/5.11.0/docs/learn/adding-and-configuring-an-identity-provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ security realm.
1313

1414
The responsibility of the identity provider configuration is to
1515
represent external identity providers. These external identity providers
16-
can be Facebook, Yahoo, Google, Salesforce, Microsoft Windows Live, etc.
16+
can be Facebook, Yahoo, Google, Salesforce, Microsoft login, etc.
1717
If you want to authenticate users against these identity providers, then
1818
you must associate one or more federated authenticators with the WSO2
1919
Identity Server. These identity providers support for different

en/identity-server/5.11.0/docs/learn/configuring-microsoft-windows-live.md renamed to en/identity-server/5.11.0/docs/learn/configuring-microsoft-login.md

Lines changed: 71 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,74 @@
1-
# Configuring Microsoft Windows Live
1+
# Configuring Microsoft login
22

3-
Microsoft Windows Live can be used as a federated authenticator in the
3+
Microsoft login can be used as a federated authenticator in the
44
Identity Server. Do the following to configure the Identity Server to
5-
authenticate users using their Microsoft Live user accounts.
5+
authenticate users using their Microsoft accounts.
66

7-
!!! tip "Before you begin"
8-
9-
1. [Register an application on Windows
10-
Live](https://msdn.microsoft.com/en-us/library/hh826541.aspx).
11-
2. Sign in to the WSO2 Identity Server [Management
7+
# Configure Microsoft login as a federated authenticator
8+
9+
Microsoft login can be used as a federated authenticator in the
10+
Identity Server.
11+
12+
Follow the steps given below to configure WSO2 Identity Server to
13+
authenticate users with their Microsoft accounts.
14+
15+
## Register WSO2 Identity Server on Microsoft
16+
17+
You need to register WSO2 Identity Server as an OAuth2.0 application on Microsoft Entra ID.
18+
19+
!!! note
20+
For detailed instructions, you can follow the [Microsoft documentation](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app){:target="_blank"}.
21+
22+
1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/){:target="_blank"} using an account with administrator permission.
23+
24+
!!! note
25+
You must use an account in the same Microsoft 365 subscription (tenant) with which you intend to register the app.
26+
27+
2. Go to **Identity** > **Applications** > **App registrations** and select **New registration**.
28+
29+
3. Click **Add** and select **App registration** from the list.
30+
31+
4. Provide the required information for app registration.
32+
33+
![Register an application on the Microsoft Entra admin center]({{base_path}}/assets/img/guides/idp/microsoft-idp/register-an-application.png){: width="600" style="display: block; margin: 0; border: 0.3px solid lightgrey;"}
34+
35+
<table>
36+
<tr>
37+
<th>Parameter</th>
38+
<th>Description</th>
39+
</tr>
40+
<tr>
41+
<td>Name</td>
42+
<td>Enter a meaningful name for your application.</td>
43+
</tr>
44+
<tr>
45+
<td>Supported Account Type</td>
46+
<td>Select the supported account type. <br><b>Value: </b><code>Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g., Skype, Xbox)</code></td>
47+
</tr>
48+
<tr>
49+
<td>Redirect URI</td>
50+
<td>Select <b>Web</b> as the platform and provide the URL to redirect after the login is completed.<br><b>Value:</b> <code>{{product_url_format}}/commonauth</code></td>
51+
</tr>
52+
</table>
53+
54+
5. Click **Register** to create the application.
55+
56+
!!! note
57+
Take note of the client ID after the application is created.
58+
59+
Now, let's generate a client secret for the application.
60+
61+
1. Go to **Certificates & secrets** on the left navigation and click **+ New client secret**.
62+
2. Enter a description for the client secret and select the expiry time.
63+
3. Click **Add** to add the client secret.
64+
65+
!!! note "Important"
66+
Take note of the generated **Value**. Microsoft Entra will allow copying this value only once. This value is the newly generated client secret for your Microsoft connection in WSO2 Identity Server.
67+
68+
69+
!!! tip "Before you register the Microsoft IdP"
70+
71+
1. Sign in to the WSO2 Identity Server [Management
1272
Console](../../setup/getting-started-with-the-management-console)
1373
at ` https://<Server Host>:9443/carbon ` using your
1474
` username ` and ` password ` .
@@ -34,17 +94,15 @@ authenticate users using their Microsoft Live user accounts.
3494

3595
4. Fill in the following fields where relevant.
3696
Prior to configuring, you need to have an application created in
37-
Windows live. See [Configuring your
38-
app](https://msdn.microsoft.com/en-us/library/hh826541.aspx) to
39-
create an application in Windows Live.
97+
Microsoft login.
4098

4199
| Field | Description | Sample value |
42100
|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
43101
| Enable | Selecting this option enables Microsoft to be used as an authenticator for users provisioned to the Identity Server. | Selected |
44102
| Default | Selecting the **Default** check box signifies that Microsoft is the main/default form of authentication. This removes the selection made for any other **Default** checkboxes for other authenticators. | Selected |
45-
| Client Secret | This is the password from the Microsoft Live application. Click the **Show** button to view the value you enter. | 12ffb4dfb2fed67a00846b42126991f8 |
103+
| Client Secret | This is the password from the Microsoft login application. Click the **Show** button to view the value you enter. | 12ffb4dfb2fed67a00846b42126991f8 |
46104
| Callback URL | This is the URL to which the browser should be redirected after the authentication is successful. It should have this format: ` https://(host-name):(port)/acs ` | [https://localhost:9443/commonauth](https://www.google.com/url?q=https%3A%2F%2Flocalhost%3A9443%2Fcommonauth&sa=D&sntz=1&usg=AFQjCNG7dB10sZ-F07Du9Q5fT-mVDMfobg) |
47-
| Client Id | This is the username from the Microsoft Live application. | 1421263438188909 |
105+
| Client Id | This is the username from the Microsoft login application. | 1421263438188909 |
48106

49107
!!! info "Related Topics"
50108

0 commit comments

Comments
 (0)