Skip to content

Commit ae39363

Browse files
Update how-to-manage-users.md
Feedback from C&E team - 14268
1 parent 9e83197 commit ae39363

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

articles/energy-data-services/how-to-manage-users.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,16 @@ ms.date: 08/19/2022
99
ms.custom: template-how-to #Required; leave this attribute/value as-is.
1010
---
1111

12-
# How to manage users?
13-
This article describes how to manage users in Microsoft Energy Data Services Preview. It uses the [entitlements API](https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/tree/master/) and acts as a group-based authorization system for data partitions within Microsoft Energy Data Service instance. For more information about Microsoft Energy Data Services Preview entitlements, see [entitlement services](concepts-entitlements.md).
12+
# How to manage users
13+
In this article, you'll know how to manage users in Microsoft Energy Data Services Preview. It uses the [entitlements API](https://community.opengroup.org/osdu/platform/security-and-compliance/entitlements/-/tree/master/) and acts as a group-based authorization system for data partitions within Microsoft Energy Data Service instance. For more information about Microsoft Energy Data Services Preview entitlements, see [entitlement services](concepts-entitlements.md).
1414

1515
[!INCLUDE [preview features callout](./includes/preview/preview-callout.md)]
1616

1717
## Prerequisites
1818

19-
Create a Microsoft Energy Data Services Preview instance using guide at [How to create Microsoft Energy Data Services Preview instance](quickstart-create-microsoft-energy-data-services-instance.md).
19+
Create a Microsoft Energy Data Services Preview instance using the tutorial at [How to create Microsoft Energy Data Services Preview instance](quickstart-create-microsoft-energy-data-services-instance.md).
2020

21-
Keep the following values handy. These values will be used to:
22-
23-
* Generate the access token, which you'll need to make valid calls to the Entitlements API of your Microsoft Energy Data Services Preview instance
24-
* Pass as parameters for different user management requests to the Entitlements API.
21+
You will need to pass parameters for generating the access token, which you'll need to make valid calls to the Entitlements API of your Microsoft Energy Data Services Preview instance. You will also need these parameters for different user management requests to the Entitlements API. Hence Keep the following values handy for these actions.
2522

2623
#### Find `tenant-id`
2724
Navigate to the Azure Active Directory account for your organization. One way to do so is by searching for "Azure Active Directory" in the Azure portal's search bar. Once there, locate `tenant-id` under the basic information section in the *Overview* tab. Copy the `tenant-id` and paste in an editor to be used later.
@@ -33,15 +30,17 @@ Navigate to the Azure Active Directory account for your organization. One way to
3330
#### Find `client-id`
3431
Often called `app-id`, it's the same value that you used to register your application during the provisioning of your [Microsoft Energy Data Services Preview instance](quickstart-create-microsoft-energy-data-services-instance.md). You'll find the `client-id` in the *Essentials* pane of Microsoft Energy Data Services Preview *Overview* page. Copy the `client-id` and paste in an editor to be used later.
3532

36-
> [!NOTE]
33+
> [!IMPORTANT]
3734
> The 'client-id' that is passed as values in the entitlement API calls needs to be the same which was used for provisioning of your Microsoft Energy Data Services Preview instance.
35+
3836
:::image type="content" source="media/how-to-manage-users/client-id-or-app-id.png" alt-text="Screenshot of finding the client-id for your registered App.":::
3937

4038
#### Find `client-secret`
41-
Sometimes called an application password, a `client-secret` is a string value your app can use in place of a certificate to identity itself. Navigate to *App Registrations*. Once there, open 'Certificates & secrets' under the *Manage* section.Create a `client-secret` for the `client-id` that you used to create your Microsoft Energy Data Services Preview instance, you can add one now by clicking on *New Client Secret*. Record the secret's `value` for use in your client application code.
39+
Sometimes called an application password, a `client-secret` is a string value your app can use in place of a certificate to identity itself. Navigate to *App Registrations*. Once there, open 'Certificates & secrets' under the *Manage* section. Create a `client-secret` for the `client-id` that you used to create your Microsoft Energy Data Services Preview instance, you can add one now by clicking on *New Client Secret*. Record the secret's `value` for use in your client application code.
4240

43-
> [!NOTE]
41+
> [!CAUTION]
4442
> Don't forget to record the secret's value for use in your client application code. This secret value is never displayed again after you leave this page at the time of creation of 'client secret'.
43+
4544
:::image type="content" source="media/how-to-manage-users/client-secret.png" alt-text="Screenshot of finding the client secret.":::
4645

4746
#### Find the `url`for your Microsoft Energy Data Services Preview instance
@@ -51,11 +50,11 @@ Navigate to your Microsoft Energy Data Services Preview *Overview* page on Azure
5150

5251
#### Find the `data-partition-id` for your group
5352
You have two ways to get the list of data-partitions in your Microsoft Energy Data Services Preview instance.
54-
- By navigating *Data Partitions* menu-item under the Advanced section of your Microsoft Energy Data Services Preview UI.
53+
- One option is to navigate *Data Partitions* menu item under the Advanced section of your Microsoft Energy Data Services Preview UI.
5554

5655
:::image type="content" source="media/how-to-manage-users/data-partition-id.png" alt-text="Screenshot of finding the data-partition-id from the Microsoft Energy Data Services Preview instance.":::
5756

58-
- By clicking on the *view* below the *data partitions* field in the essentials pane of your Microsoft Energy Data Services Preview *Overview* page.
57+
- Another option is by clicking on the *view* below the *data partitions* field in the essentials pane of your Microsoft Energy Data Services Preview *Overview* page.
5958

6059
:::image type="content" source="media/how-to-manage-users/data-partition-id-second-option.png" alt-text="Screenshot of finding the data-partition-id from the Microsoft Energy Data Services Preview instance overview page.":::
6160

@@ -89,7 +88,7 @@ curl --location --request POST 'https://login.microsoftonline.com/<tenant-id>/oa
8988
Copy the `access_token` value from the response. You'll need it to pass as one of the headers in all calls to the Entitlements API of your Microsoft Energy Data Services Preview instance.
9089

9190
## User management activities
92-
You can manage user's access to your Microsoft Energy Data Services instance or data partitions. As a prerequisite for the same, you need to find the 'object-id' (OID) of the user(s) first.
91+
You can manage user's access to your Microsoft Energy Data Services instance or data partitions. As a prerequisite for this step, you need to find the 'object-id' (OID) of the user(s) first.
9392

9493
You'll need to input `object-id` (OID) of the users as parameters in the calls to the Entitlements API of your Microsoft Energy Data Services Preview Instance. `object-id`(OID) is the Azure Active Directory User Object ID.
9594

@@ -121,8 +120,8 @@ Run the below curl command in Azure Cloud Bash to add user(s) to the "Users" gro
121120
"role": "MEMBER"
122121
}'
123122
```
124-
> [!NOTE]
125-
> The value to be sent for the param "email" is the Object ID of the user and not the user's email
123+
124+
The value to be sent for the param **"email"** is the **Object_ID (OID)** of the user and not the user's email
126125

127126
**Sample request**
128127

@@ -160,8 +159,8 @@ Run the below curl command in Azure Cloud Bash to add user(s) to an entitlement
160159
"role": "MEMBER"
161160
}'
162161
```
163-
> [!NOTE]
164-
> The value to be sent for the param "email" is the Object ID of the user and not the user's email
162+
The value to be sent for the param **"email"** is the **Object_ID (OID)** of the user and not the user's email
163+
165164
**Sample request**
166165

167166
```bash
@@ -226,8 +225,8 @@ Run the below curl command in Azure Cloud Bash to get all the groups associated
226225

227226
Run the below curl command in Azure Cloud Bash to delete a given user to your Microsoft Energy Data Services instance data partition.
228227

229-
> [!NOTE]
230-
> As stated above, **DO NOT** delete the OWNER of a group unless you have another OWNER that can manage users in that group.
228+
As stated above, **DO NOT** delete the OWNER of a group unless you have another OWNER that can manage users in that group.
229+
231230
```bash
232231
curl --location --request DELETE 'https://<URI>/api/entitlements/v2/members/<OBJECT_ID>' \
233232
--header 'data-partition-id: <data-partition-id>' \

0 commit comments

Comments
 (0)