Skip to content

Commit 1b94c4a

Browse files
authored
Merge pull request #28918 from MicrosoftDocs/daisyfell-hrsd
Update servicenow-hrsd-itsm.md
2 parents ad45960 + 9debf97 commit 1b94c4a

1 file changed

Lines changed: 85 additions & 3 deletions

File tree

copilot/employee-self-service/servicenow-hrsd-itsm.md

Lines changed: 85 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Refer to the ESS Agent deployment guide for installation of the agent and subscr
7373
| **Application Developer** (*minimum privileged role*) | User who can register an application | Create an App registration - *if using Microsoft Entra OAuth for ServiceNow connector* | Microsoft 365 Admin Center |
7474
| **Environment Maker** | User who can customize ESS Agent | Configure & Customize ESS Agent | Microsoft Copilot Studio |
7575

76-
### ServiceNow configuration
76+
## ServiceNow configuration
7777

7878
This section outlines the tasks required to be configured in ServiceNow by an administrator. ServiceNow integration supports three types of authentications as follows:
7979

@@ -88,7 +88,86 @@ This section outlines the tasks required to be configured in ServiceNow by an ad
8888
> [!TIP]
8989
> Without elevating access, the new security objects can't be created. If **New** button in the top right of configuration pane is missing, then the role isn't elevated to "`security_admin`”.
9090
91-
#### Option 1: Using OAuth2 authentication - Create an OAuth Application Registry
91+
### Basic authentication
92+
93+
This method of authentication involves a ServiceNow username and password to authenticate API requests. This method is simple to use and is primarily suggested for testing purposes, as it offers lower security compared to other authentication methods.
94+
95+
### Microsoft EntraID OAuth using Certificate
96+
97+
This authentication uses app tokens, allowing a registered Entra ID application to access ServiceNow with a token specifying the ServiceNow Entra ID app as the resource.
98+
99+
#### Task 1: Register an application in Microsoft Entra ID for OIDC integration with ServiceNow
100+
101+
[Learn how to register an app in Microsoft Entra ID.](/entra/identity-platform/quickstart-register-app)
102+
103+
1. Sign into the Microsoft Entra admin portal as a global administrator or cloud app administrator.
104+
1. Go to **Applications** then **App registrations**.
105+
1. Select **New registration.**
106+
1. In the new registration form, fill in the following fields:
107+
1. **Name:** Any name that represents the purpose of app registratio
108+
1. **Redirect URL:** Not needed
109+
1. Choose **Register** to complete the creation of the new app registration.
110+
1. Select **Token configuration** then **Add optional claim** for adding claims setting.
111+
1. Select **Token type** as **Access** and choose the following claims:
112+
1. *aud* - for audience validation
113+
1. *email* - addressable email for user
114+
1. *upn* - an identifier for the user
115+
1. Select **Add** to complete adding the claims.
116+
1. If this is the first time OpenId Connect being setup using claims like email, upn, there’ll be a confirmation to turn on the Microsoft Graph permissions, please check the box and select **Add**.
117+
1. This flow completes the Microsoft Entra piece of configuration.
118+
119+
#### Task 2: Register OIDC provider in ServiceNow
120+
121+
1. Login to the ServiceNow instance that needs to be integrated with ESS Agent.
122+
1. Elevate access permissions using **Elevate role**. Refer to the section **Error! Reference source not found.** – only the first part and not the tasks.
123+
1. Click **All** in the top navigation bar.
124+
1. Search for “OAuth” in the search box within dropdown navigation menu.
125+
1. Select **System OAuth à Application Registry** from the search results (if you don’t see this option, then you don’t have sufficient privileges).
126+
1. Select **New** in the configuration section pane.
127+
1. Select **Configure an OIDC provider to verify ID tokens**.
128+
1. Fill in the following information for the new application registry:
129+
130+
|Configuration |Description |
131+
|--------------|------------|
132+
|Name |a meaningful name to identify that this OIDC provider was created for ESS Agent |
133+
|Client ID |The client ID of Entra Application created in Task 1 above |
134+
|Client secret |This value will not be used; can be any value |
135+
|OAuth OIDC provider configuration |Add a new OIDC provider configuration by selecting the search icon and choosing **New** in the search popup. Fill in the fields as follows:</br> **OIDC Provider:** A name that represents the Microsoft Entra tenant from task 1 above.</br> **OIDC Metadata URL:** `login.microsoftonline.com/<tenant ID>/.well-known/openid-configuration`</br> Replace < tenant ID > with the Entra tenant ID from task 1 above.</br> **OIDC Configuration Cache Life Span:** 120</br> **Application:** Global</br> **User Claim:** oid</br> **User Field:** User ID</br> **Enable JTI claim verification:** disabled</br> Select **Submit** and update the OIDC Entity form. |
136+
137+
#### Task 3: Register an Application in Microsoft Entra ID for connector usage
138+
139+
This is the application which plays the role of a user with elevated permissions in the ServiceNow instance.
140+
141+
1. Login to Entra administration portal as global administrator (or) cloud app administrator.
142+
1. Go to **Applications** > **App registrations**.
143+
1. Select **New registration**.
144+
1. In the new registration form, fill in the following fields:.
145+
1. **Name:** any name that represents the purpose of app registration.
146+
2. **Redirect URI:** Not needed.
147+
1. Click **Register** to complete the creation of new app registration.
148+
1. Select **Certificates & secrets** then upload the .cer file of the certificate. In case of SNI certificate, just add trustedCertificateSubjects in the manifest of the application with the relevant authorityId and subjectName.
149+
150+
#### Task 4: Create a System User in ServiceNow
151+
152+
This is the Application created in the above task 3 which is a user in ServiceNow instance.
153+
154+
Go to **User Administration** > **Users** to create a new user.
155+
156+
**User ID:** The object ID of the service principal of Application created in Task 3 above.
157+
158+
Check **Web service access only**.
159+
160+
### Microsoft Entra ID OAuth User Login
161+
162+
This is user-token based authentication where the end user can sign into Entra ID 1st party application i.e. ServiceNow connector 1st party app and get an access token with scope for the ServiceNow representative Entra ID app.
163+
164+
Perform Task 1 & Task 2 from the previous section Microsoft Entra ID OAuth using Certificate.
165+
166+
In the Task 1 – add the 1st party application i.e., ServiceNow connector to the permission scope – Client ID = c26b24aa-7874-4e06-ad55-7d06b1f79b63.
167+
168+
In the Task 2 – update the user claim to upn or any other custom claim property from the token in ServiceNow. The user field should match the ServiceNow system user table field containing the upn or user ID.
169+
170+
### Using OAuth2 authentication - Create an OAuth Application Registry
92171

93172
1. Log in to the ServiceNow instance that needs to be integrated with ESS Agent.
94173
2. Elevate access permissions using **Elevate role**.
@@ -104,7 +183,7 @@ This section outlines the tasks required to be configured in ServiceNow by an ad
104183
| **Name** | a meaningful name to identify that this application registry is created for ESS Agent |
105184
| **Client ID** | autogenerated code <br><div class="alert">**Note**</br>This value is used in Microsoft 365 Copilot Connector configuration, if no Advanced Scripting is used. |
106185
| **Client Secret** | leave it blank to automatically generate a string <br><div class="alert">**Note**</br>This value is used in Microsoft 365 Copilot Connector configuration, if no Advanced Scripting is used. |
107-
| **Redirect URL** | a required callback URL that the authorization server redirects to </br>For Microsoft 365 Enterprise:</br>`https://gcs.office.com/v1.0/admin/oauth/callback`</br>For Microsoft 365 Government:</br>`https://gcsgcc.office.com/v1.0/admin/oauth/callback`|
186+
| **Redirect URL** | a required callback URL that the authorization server redirects to </br>For Microsoft 365 Enterprise:</br>`https://gcs.office.com/v1.0/admin/oauth/callback`</br>For Microsoft 365 Government:</br>`https://gcsgcc.office.com/v1.0/admin/oauth/callback` Refer to the note after the table for more information.|
108187
| **Logo URL** | A URL that contains the image for the application logo |
109188
| **Active** | Set to active |
110189
| **Refresh token lifespan** | The number of seconds that a refresh token is valid. </br>By default, refresh tokens expire in 100 days (8,640,000 seconds). Recommended value is 31,536,000 (one year) |
@@ -113,6 +192,9 @@ This section outlines the tasks required to be configured in ServiceNow by an ad
113192
| **Accessible from** | All application scopes |
114193
| **Client Type** | Integration as a Service |
115194

195+
>[!NOTE]
196+
>[Please use the actual callback URL from the sign-in popup window during connection configuration by following the steps below, when the URL redirection fails with the error **Invalid redirect_uri**:</br> Copy/paste the complete URL from the authorization popup window</br> Extract redirect_uri parameter.</br> Example: `redirect_uri=https%3a%2f%2ftip1-shared.consent.azure-apim.net%2fredirect`</br> After decoding the URL – replacing %3a with : and %2f with /</br> Update the Redirect URL field.]
197+
116198
9. Select **Submit** or **Update** button to save the changes.
117199

118200
### Install ServiceNow HRSD extension pack

0 commit comments

Comments
 (0)