Apply sensitivity label in SharePoint using Postman tool

Apply sensitivity label in SharePoint using Postman tool

No comments

 1,826 total views,  1 views today

In this article, we will learn how to apply a sensitivity label in SharePoint using the postman tool. Here we have assumed that you have a basic understanding of what is a sensitivity label and how to apply it to the Microsoft Office file (like Word, Excel, PPT, etc).

In simple words, a sensitivity label is a data classification like Public, Confidential, Highly Confidential, etc.

 

To know more about the data classification & sensitivity label, you may look at the below articles:

Now, let’s get back to the context of this article. In the previous article, we have learned how to get and copy the bearer token value from Sharepoint – in this article, we will learn how to use that bearer token value in the postman tool to do a post-operation in SharePoint Online, here as an example we will use how to apply a sensitivity label using the SharePoint API.

Here is the SharePoint API which we will use for applying the sensitivity label:

API Syntax:

https://yourspositeURL/_api/v2.1/drives/DocumentLibraryID/items/DocumentID/setsensitivityLabel

Example:

https://globalsharepoint2020.sharepoint.com/_api/v2.1/drives/b!_gbrdwjBJUi-RT40bK2ugHGZ7QDqj1RFnI_Q4lVGhqmtoFYS9HieT5Rl6tvwhWR2/items/0A5D5112-B937-4246-8339-85E4795A0A65/setsensitivityLabel

Notes:

How to get the Document ID in SharePoint Online?

We just, need to open the document for which we want to apply the sensitivity label in the browser. For an example, below:

Get Document ID from SharePoint Online Document library
Get Document ID from SharePoint Online Document library

Notes:

  • Note down the URL, and the URL will look like below:
https://globalsharepoint2020.sharepoint.com/:w:/r/_layouts/15/Doc.aspx?sourcedoc=%7B0A5D5112-B937-4246-8339-85E4795A0A65%7D&file=My%20Test%20File.docx&action=default&mobileredirect=true&cid=5743bcd3-c190-4c31-96a8-44194bcab7d2
  • In the URL, we can see one of the query string parameters is the “sourcedoc” which is in an encoded format, we need to decode it (sourcedoc=%7B0A5D5112-B937-4246-8339-85E4795A0A65%7D).
  • Using the Online tool like URL Decoder/Encoder, we can decode it, after decoding the “sourcedoc” value will be like  “0A5D5112-B937-4246-8339-85E4795A0A65
  • So, by now we got the document ID also.
  • And the right topmost corner, we can see there are two sensitivity labels to this location, and we can apply any of them – at present this document has not been applied with any sensitivity labels. In this demo, we will apply the “Confidential Test – Label” to this document.

 

By now we have all the needed parameters for this sensitivity label API like:

One more thing we need to get is the sensitivity label ID the one which we are going to apply. We can get the sensitivity label ID using this article – Get sensitivity labels using PowerShell script.

For this demo, the sensitivity label ID is: 90ebdb98-631f-453a-bf00-6f388e5b5206 (Confidential Test – Label).

Now, everything is ready, we are ready to go for postman execution.

Let’s launch the postman tool.

Select the operation as “POST”

Pass the Sensitivity Label API URL like below:

https://globalsharepoint2020.sharepoint.com/_api/v2.1/drives/b!_gbrdwjBJUi-RT40bK2ugHGZ7QDqj1RFnI_Q4lVGhqmtoFYS9HieT5Rl6tvwhWR2/items/0A5D5112-B937-4246-8339-85E4795A0A65/setsensitivityLabel
Sensitivity label API Header Configuration in Postman tool
Sensitivity label API Header Configuration in Postman tool

Header Configuration should be as below:

Authorization – Bearer

Accept – application/json;odata=verbose

Content-Type – application/json;odata=verbose

Now, let’s configure the Body of the API:

Sensitivity label API Body Configuration in Postman tool
Sensitivity label API Body Configuration in Postman tool

In the body of the API pass the below:

{
  “id”: “90ebdb98-631f-453a-bf00-6f388e5b5206“,
    “justificationText”: “Applying Sample label via Postman tool”,
    “assignmentMethod”: “standard”,
    “ifMatchLabelId”:””
}

Note:

  • In the above, the “id” is the sensitivity label id parameter which is mandatory rest other parameters are optional. We have got this sensitivity label ID (90ebdb98-631f-453a-bf00-6f388e5b5206 (Confidential Test – Label)) in the above step which we are going to apply to the particular document.

Then let’s configure the authorization section for this API.

Bearer Token configuration in postman authorization section
Bearer Token configuration in the postman authorization section

Click on the “Authorization” tab.

From the type of Authorization, select the “Bearer Token”.

And in the Token Text Box, place or paste the bearer token value which we got referring to this article – How to get Bearer Token For SharePoint?.

Finally, click on the “Send” button.

Apply sensitivity label in SharePoint file using the postman tool
Apply sensitivity label in SharePoint file using the postman tool

We can see the status as “200 Ok” which means, this API has been executed successfully.

Now, if we open the particular file from the SharePoint document library we can see that the “Confidential Test – Label” has been applied to this document which was not there before executing the API from the postman tool.

Sensitivity label has been applied to the file in SharePoint using postman tool
Sensitivity label has been applied to the file in SharePoint using postman tool

Notes:

  • Sometimes, we might get a token expiration error like the below from the postman tool, in this case, we need to generate the token value freshly and pass it to the postman authorization configuration.

{“error”:{“code”:”unauthenticated”,”innerError”:{“code”:”expiredToken”},”message”:”The access token has expired. It’s valid from ‘4/17/2022 5:31:52 AM’ and to ‘4/17/2022 6:31:52 AM’.”}}

  • And sometimes, we might get a document lock state error while applying the sensitivity label, in this case, we need to close the document from the browser.

Summary: what did we have here in – Apply sensitivity label in SharePoint?

Thus, in this article, we have learned how to apply the sensitivity label in the document stored in the SharePoint document library using the postman tool and SharePoint API.

See Also

You might be interested in the following sensitivity & postman tool-related articles:

 

About Post Author

Do you have a better solution or question on this topic? Please leave a comment