Skip to content

Commit dc3a7e0

Browse files
vinokuriggtrivedi88
vinokurig
and
gtrivedi88
authored
Update Azure DevOps Oauth configuration instructions (#3036)
* Update Azure DevOps Oauth configuration instructions * Update modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * Update modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com> * fixup! Update modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc --------- Co-authored-by: Gaurav Trivedi <90042568+gtrivedi88@users.noreply.github.com>
1 parent 6ec9374 commit dc3a7e0

3 files changed

Lines changed: 32 additions & 42 deletions

‎modules/administration-guide/pages/configuring-oauth-2-for-microsoft-azure-devops-services.adoc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ To enable users to work with a remote Git repository that is hosted on Microsoft
1313

1414
pass:[<!-- vale RedHat.Spelling = YES -->]
1515

16-
. Set up the Microsoft Azure DevOps Services OAuth App (OAuth 2.0).
17-
. Apply the Microsoft Azure DevOps Services OAuth App Secret.
16+
. Set up an application in Microsoft Entra ID.
17+
. Apply the Microsoft Entra ID App Secret.
1818

19-
[IMPORTANT]
20-
OAuth 2.0 isn't supported on Azure DevOps Server, see link:https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops[the documentation page].
21-
[IMPORTANT]
22-
Azure DevOps OAuth 2.0 is deprecated and no longer accepts new registrations, with full deprecation planned for 2026. See link:https://learn.microsoft.com/en-us/azure/devops/integrate/get-started/authentication/oauth?view=azure-devops[the documentation page].
19+
[NOTE]
20+
====
21+
Microsoft Entra ID replaces the deprecated Azure DevOps OAuth 2.0 application, which no longer accepts new registrations. If you have an existing Azure DevOps OAuth app, migrate to Microsoft Entra ID.
22+
====
2323

2424
include::partial$proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc[leveloffset=+1]
2525

‎modules/administration-guide/partials/proc_applying-the-microsoft-azure-devops-services-oauth-app-secret.adoc‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
:_content-type: PROCEDURE
2-
:description: Applying the Microsoft Azure DevOps Services OAuth App Secret
3-
:keywords: microsoft-azure-devops-services-oauth-app, apply, secret
4-
:navtitle: Applying the Microsoft Azure DevOps Services OAuth App Secret
2+
:description: Applying the Microsoft Entra ID OAuth App Secret
3+
:keywords: microsoft-azure-devops-entra-id-oauth-app, apply, secret
4+
:navtitle: Applying the Microsoft Entra ID OAuth App Secret
55
// :page-aliases:
66

7-
[id="applying-the-microsoft-azure-devops-services-oauth-app-secret"]
8-
= Applying the Microsoft Azure DevOps Services OAuth App Secret
7+
[id="applying-the-microsoft-entra-id-oauth-app-secret"]
8+
= Applying the Microsoft Entra ID OAuth App Secret
99

10-
Prepare and apply the Microsoft Azure DevOps Services Secret.
10+
Prepare and apply the Secret that enables {prod-short} to authenticate with Microsoft Entra ID for Azure DevOps repository access.
1111

1212
.Prerequisites
1313

14-
* Setting up the Microsoft Azure DevOps Services OAuth App is completed.
14+
* You have set up the Microsoft Entra ID OAuth App.
1515

16-
* The following values, which were generated when setting up the Microsoft Azure DevOps Services OAuth App, are prepared:
17-
** *App ID*
16+
* The following values, which were generated when setting up the Microsoft Entra ID OAuth App, are prepared:
17+
** *Application (client) ID*
18+
** *Directory (tenant) ID*
1819
** *Client Secret*
1920

2021
* An active `{orch-cli}` session with administrative permissions to the destination {orch-name} cluster. See {orch-cli-link}.
@@ -37,12 +38,14 @@ metadata:
3738
che.eclipse.org/oauth-scm-server: azure-devops
3839
type: Opaque
3940
stringData:
40-
id: __<Microsoft_Azure_DevOps_Services_OAuth_App_ID>__# <2>
41-
secret: __<Microsoft_Azure_DevOps_Services_OAuth_Client_Secret>__# <3>
41+
tenant-id: __<Microsoft_Entra_ID_Tenant_ID>__# <2>
42+
id: __<Microsoft_Entra_ID_App_ID>__# <3>
43+
secret: __<Microsoft_Entra_ID_Client_Secret>__# <4>
4244
----
4345
<1> The {prod-short} namespace. The default is `{prod-namespace}`.
44-
<2> The Microsoft Azure DevOps Services OAuth *App ID*.
45-
<3> The Microsoft Azure DevOps Services OAuth *Client Secret*.
46+
<2> The Microsoft Entra ID *Directory (tenant) ID*.
47+
<3> The Microsoft Entra ID *Application (client) ID*.
48+
<4> The Microsoft Entra ID *Client Secret*.
4649

4750
. Apply the Secret:
4851
+

‎modules/administration-guide/partials/proc_setting-up-the-microsoft-azure-devops-services-oauth-app.adoc‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
:_content-type: PROCEDURE
2-
:description: Setting up the Microsoft Azure DevOps Services OAuth App
2+
:description: Setting up the Microsoft Entra ID OAuth App
33
:keywords: azure, devops, oauth
4-
:navtitle: Setting up the Microsoft Azure DevOps Services OAuth App
4+
:navtitle: Setting up the Microsoft Entra ID OAuth App
55
// :page-aliases:
66

77
pass:[<!-- vale RedHat.TermsWarnings = NO -->]
88

9-
[id="setting-up-the-microsoft-azure-devops-services-oauth-app"]
10-
= Setting up the Microsoft Azure DevOps Services OAuth App
9+
[id="setting-up-the-microsoft-entra-id-oauth-app"]
10+
= Setting up the Microsoft Entra ID OAuth App
1111

12-
Set up a Microsoft Azure DevOps Services OAuth App using OAuth 2.0.
12+
Set up a Microsoft Entra ID OAuth App to enable {prod-short} users to interact with Azure DevOps Git repositories without re-entering credentials.
1313

1414
.Prerequisites
1515

@@ -23,24 +23,11 @@ Set up a Microsoft Azure DevOps Services OAuth App using OAuth 2.0.
2323

2424
.Procedure
2525

26-
. Visit link:https://app.vsaex.visualstudio.com/app/register/[].
27-
28-
. Enter the following values:
29-
30-
.. *Company name*: `{prod-short}`
31-
.. *Application name*: `{prod-short}`
32-
.. *Application website*: `pass:c,a,q[{prod-url}]/`
33-
.. *Authorization callback URL*: `pass:c,a,q[{prod-url}]/api/oauth/callback`
34-
35-
. In *Select Authorized scopes*, select *Code (read and write)*.
36-
37-
. Click *Create application*.
38-
39-
. Copy and save the *App ID* for use when applying the Microsoft Azure DevOps Services OAuth App Secret.
40-
41-
. Click *Show* to display the *Client Secret*.
42-
43-
. Copy and save the *Client Secret* for use when applying the Microsoft Azure DevOps Services OAuth App Secret.
26+
. Register an application in Microsoft Entra ID. See link:https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app[Register an application].
27+
. Add the *Authorization callback URL* `pass:c,a,q[{prod-url}]/api/oauth/callback` to your application. See link:https://learn.microsoft.com/en-us/entra/identity-platform/how-to-add-redirect-uri[Add a redirect URI].
28+
. Add a client secret to your application. See link:https://learn.microsoft.com/en-us/entra/identity-platform/how-to-add-credentials?tabs=client-secret[Add credentials].
29+
. Add the Azure DevOps `vso.code_write` permission to the client application. See link:https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-configure-app-access-web-apis#add-permissions-to-access-your-web-api[Add permissions to access your web API].
30+
. Connect your Azure DevOps organization to Microsoft Entra ID. See link:https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/connect-organization-to-azure-ad?view=azure-devops#connect-your-organization-to-microsoft-entra-id-1[Connect your organization to Microsoft Entra ID].
4431

4532
pass:[<!-- vale RedHat.TermsWarnings = YES -->]
4633

0 commit comments

Comments
 (0)