Microsoft 365 Community Microsoft Graph, 20 Oct 2022

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Introduction to Privacy APIs on Microsoft Graph

Description

In this 13-minute developer focused demo – Brian T. Jacket and Cameron Parker show viewers how to automate Security, Compliance, Identity and Management (SCIM) with new Microsoft Graph APIs for Records Management, eDiscovery Premium and Privacy. Today’s demo specifically focuses on Privacy or Subject Rights Requests (SRR) – creation and status. See SRR queries in Postman and results in Rights Requests portal. Details about licensing/monetization, demo environments/trials and available resources. The APIs will be soon available GA on the v1 endpoint. This PnP Community demo is taken from the weekly Microsoft 365 Platform Community call recorded on October 4, 2022.

Demo Presenters
• Brian T. Jackett (Microsoft) | @BrianTJackett
• Cameron Parker (Microsoft)

Supporting materials
• Documentation - Create subjectRightsRequest | https://learn.microsoft.com/graph/api/subjectrightsrequest-post
• Documentation - Get subjectRightsRequest | https://learn.microsoft.com/graph/api/subjectrightsrequest-get
• Documentation - Effective permissions | https://learn.microsoft.com/graph/auth/auth-concepts?context=graph%2Fapi%2F1.0&view=graph-rest-1.0#effective-permissions
• Documentation - Set user permissions and assign roles in Microsoft Priva | https://learn.microsoft.com/privacy/priva/priva-permissions
• Tools - Join the Microsoft 365 Developer Program today! | aka.ms/M365DevProgram
• Trial – Priva - Privacy risk management overview | aka.ms/TryPriva
• Documentation - Use Postman with the Microsoft Graph API | aka.ms/GraphPostman
• Documentation - Use the Microsoft Graph subject rights request API | https://learn.microsoft.com/graph/api/resources/subjectrightsrequest-subjectrightsrequestapioverview
• Documentation - Set user permissions and assign roles in Microsoft Priva | https://learn.microsoft.com/privacy/priva/priva-permissions

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/m365/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/m365/videos
• Microsoft 365 Platform Community - http://aka.ms/m365/community

A

Foreign good evening, everybody, my name, is Brandy jacket, joined by Cameron, Parker who's, my teammates, and we're going to do another um kind of Roundup introductions on some new apis that are coming out there. um If you were on a couple weeks ago, we did some things on the e-discovery premium, apis this time around we're actually going to talk about some of the Privacy apis.

A

uh This is all part of what we call the security compliance, identity and management skim apis, and these are going to be available to us actually in GA in this case on the V1 endpoint. So some great things we'll be able to show up for you today, all right, let's jump into things. So today, we've got a couple different things we'll be going over. I'll, give you a quick little overview of the apis themselves. Some different use cases for this Cameron's actually going to demo some of those different scenarios for more reviews.

A

So you can see what does this actually look like inside of Postman, but I also see that results of this inside of our environments as well talk a little bit about some of the licensing, slash monetization impacts for this um talk about how you can actually go and get a demo environment for this, so some great ways actually be able to try this out.

A

If you don't already have licenses or you don't have an environment, you can test this with and then we'll open things up for Q a and give you some additional resources as well. Now, as I mentioned, there are actually three sets of skim apis that are out there um today record can be focusing on the far right one out there, which is our privacy apis. This actually relates to something called subject: rights, requests or srrs if you've ever dealt with things like gdpr or the California privacy laws. um This is very much in that space.

A

Things like the right to be forgotten or the you know what data do you have on me if you're looking for that type of information within your system, basically with inside of M365, there's a great way to be able to actually go and find out hey what are those things that are content related to myself to another user, um someone else you're trying to get that subject: price request on in terms of just kind of the overall for the API with this the real goal for this is to be able to help our customers and our partners be able to automate a lot of the things that they do.

A

Maybe today in the UI or through the compliance portal, um when you have to do a lot of these kind of repetitive tasks or you've got like a bulk operation that you're trying to do for those subject, rights requests um that can be very tedious.

A

You know, would you rather have somebody you know, spending hours going and doing those you know fill in the forms and kicking off the requests for this, or would you rather be able to kind of prepare some type of CSV file or something else to input, and then just query it with the API lots of ways you can? Actually uh you have some efficiency and be able to be very productive.

A

Having that API Available to You versus having to actually do this directly through the UI for out there a couple different things we can share just from a sample use cases for this again, you can do things for automation, of um there's kind of two terms here, there's subject: price requests, there's also data, subject: requests or dsrs fairly similar just in terms of what the naming for these things are just some kind of a small small difference between them. But DSR is another term. We also will use for those srrs out there.

A

You might be trying to automate decoration all those things, and this could be coming from one business. Application could be coming from an intake form. Maybe you've got something like a power app or a power automate uh to be actually go and kick off those types of requests we're also seeing a number of third-party vendors we're also going and doing Integrations with us. They may have their own system of record.

A

They may have their own tool, their own kind of Staff service or a website, or an app that they're using, but they can actually reach into M365 and be able to automate those types of tasks directly through the apis out there. So lots of great ways we can be able to go and work with the data and want to turn things over to Cameron. To talk to us a little bit about some of the different sample queries that are out there.

B

All right thanks, Brian uh yeah, so so, basically, um one of the primary use cases we have around this is the creation right and automating that srr creation and so I just have here a sample query regarding the post operation being made to to create that subject's, uh write request, and uh so you can see populated with uh certain information that you would pass in the body of that request in order to create uh that that srr and then link to our documentation as well.

B

uh In case you want to learn more about that specific query and of course we have documentation for uh for for each of these apis uh and then so. Moving on to the uh the next use case, uh next big one's going to be getting that srr status right, so you create that srr.

B

uh You know you might have done some some other things with this, uh get some additional information or perform some action right related to that subject: rights request, and so uh we have other queries as well to get details about the srr itself that that you're, looking to get say, status. Information on as well is an API to get a final report once uh basically, you know once there's additional information, that's been added by that privacy administrator and that kind of thing, as well as an ability to both add and list notes right.

B

So if someone goes in adds a note to that particular srr, you can you can get that information as well, which again we'll be demoing here shortly uh and so uh documentation for that as well, and then uh from there I believe we can go ahead and move into the demo. So I will go ahead and share out my screen for this all right, so you can see here.

B

So this is Postman and so for anyone who's not familiar with Postman Postman is a great API testing tool that you can use to basically just craft raw HTTP queries and that kind of thing to test out uh various rest apis, and so in this case we have an official Microsoft graph, uh essentially collection, that you can Fork uh that has these these queries kind of pre-crafted, so you're not having to manually, create all of these. So in this particular case, under our compliance subfolder.

B

Here you can see the subject: rights request with our two use cases that we were discussing and we will do some test queries on and so uh just a quick note about Postman. So you can see some variables in here, as noted by the kind of uh double curly braces, and so um where that would be populated is under your variables at the top of the collection. So you can see that I've kind of got some stuff pre-populated here um and then so, let's go ahead and get started.

B

uh We will go ahead and get a access token, and so in this case we are using delegated permissions. So we're going to go ahead and basically you know populate our application registration information so that we can get that. And so you can see that these are also variables uh which I have kind of in my environment uh set up here at the top, uh and so with that we will go ahead and get our access token, and you can see that it.

B

It automatically uh went ahead and and got me my my access token that we're going to use if you were logging in for the first time being delegated permissions, you would actually get a prompt right to sign in and then, if you hadn't previously consented to the permission uh for permissions being requested right, you would see a consent prompt for that as well.

B

But of course that was done prior to this, which is why you don't see it here, all right so moving under our subjects, uh rights, requests and the uh specifically we're going to go ahead and move forward with creating uh that srr. And so you can see here.

B

I've got my post request, set up in the URL pattern for the creation of that srr and again populated with some information here, such as like regulation, the name that you want to use uh some information about the data subject of that request, and we will go ahead and send that query. And if everything goes well, we should get a successful response, takes just a few moments all right and we got back a successful response. Our HTTP 201 created, and we can see the information returned from the srr that we just created.

B

You can see, there's quite a bit of information there uh and then, in addition to that, if we go look at our uh at the portal here, uh we can do a quick, refresh and I would expect I believe it should show up by now yep and so here's our srr, that we just created as visible in the subjects rights request portal right.

B

So if you needed to do some manual action outside the API or just needed to go, look at it in the portal later time, you can see that that Sr is here and we can see that it's currently in the data estimate uh progress section so going back to postman.

B

Another option is to list srrs that you have available. If you notice from that uh the the UI right, we had several srrs there, and so you can see. Essentially, what this API is doing is enumerating that list of available srrs right, which you could use to grab the uh ID of one of these and feed that into a get request which we're actually about to do here in just a moment.

B

uh So you might be wondering kind of how we're getting that ID for this next request that we're making that we're seeing a variable for here and you can actually see it's populated. So how do we get that? Well in Postman? This particular query is set up essentially to read the response from that and then save that ID of that srr we just created into a variable all right and so again moving on to the uh tracking the status of that srr. uh Again, we've populated this variable with the srr that we just recently created.

B

So we want to get details about that specific srr, not list out. You know that that full list of the several srrs that we had created as as we saw in the portal- and so you can see here- we've got the uh the various stages uh that so that you can check information about.

B

Essentially, the status of this request right, and so you kind of saw a little bit about that when we saw the response of the srr that was just created, but you can also use this uh get srr request in order to see again the status of that request. uh Again, like we discussed earlier, there is an option to get a final report. Now you're not going to see anything for this one, uh we do get a status okay, but again it's it's just kind of like a null response right.

B

Just because we haven't completed that srr. We don't have a final report available just yet uh same. Forget final attachments. Again, these are things you get added by the Privacy administrator. You will see in error in this particular one. Just because again we don't have anything associated with this, yet being a brand new request, so we get our 404 not found there, but as I was mentioning the ability to create and list notes right.

B

So in this case we're just going to create a simple note um and send that, and we should get back a successful response for that post call. We do we get our 201 created and then we can turn around and do a list of notes. So if we had several notes, you know we can go back and check and see what our notes are and then jumping back to the uh the portal.

B

Here we can take a look at that uh that srr and we can look at things such as our notes, like our note that we just created here again and just you know, through the DUI, um seeing things like the history status, Etc all right and Brian I will go ahead and stop presenting and turn it back to you.

A

Awesome, thank you so much for showing that really great to see things not only in the API with Postman, but also going back to the portal uh and seeing where that actually shows up.

A

So, let's flip back to our slides here got a couple things to wrap up with uh one thing to note, for this is subject: rights, requests and kind of Microsoft friva space. This does require a separate set of Licensing. This is not tied to the you know: E1 E3, E5 or the a1a385 tips excuse things like that. Every time you do a subject, voice request, it will require accretion of a new one. That'll require a new essentially purchase for one of those srrs.

A

The current uh pricing for this is 200 US dollars per subject: question request if you are looking for you know bulk or volume kind of Licensing, for this please do reach out to whoever your licensing expert. Is your resellers things like that? um Just note that this is not going to be one of those apis or the things that's included directly with your existing licensing. There are some digital things for that. So please be aware of that.

A

If you're looking for a way to actually go and try this out, though, we do have a slide for that here in a second, so you can see more on that also note that if there are any types of permissions or other things that might be applicable for this, these are using delegated permissions and as such, if you're, trying to view things inside of the portal for trying to get access to different areas. There are a set of Microsoft priva roles and permissions that can apply for this.

A

Please do take a look at the URL on here, we'll post this into the chat just so you can go and take a look at that if you're looking for ways to actually go and get a demo environment for this, as we mentioned previously in the community, call, there is the Microsoft 365 developer program with that you can do get that sandbox tenant uh the 25 E5 licenses again software news out there, the other area as we're mentioning for the licensing. For this there is a trial for Microsoft preva.

A

You can go to AKA dot, Ms, slash, try, preva and you'll get a set amount of those srrs available to you inside of your tenant or you'll, get it for a specified amount of time. For that so feel free to take a look at that again. There's another way to try this out before you actually go and purchase things we'll be able to test it out there and see if it's going to meet your needs for this, and then the link also to the postman collection. um Cameron did a great job of actually packaging together.

A

The different sample queries that we have out there putting them onto the official Microsoft graph set of uh Postman collection out there. You can find more at AKA dot, Ms, slash graph, Postman and we'll leave the slide up here. Just for a second, if you do have any questions, a couple different links to show you as well. If you want to look more about those privacy apis, you can find them at AKA, dot, Ms, slash, preva, API and also as well for those permissions. Here's the URL for that as well.

A

So you can take a look at that and we'll post these things into the chat window, but from a timing, perspective, I, guess we can follow up on the questions in the chat. It's just easier that way um sure we'll follow the chat line for once all right appreciate everyone's time and have a good rest of your call. Excellent. Thank you Prime. Thank you. Cameron really, really cool stuff.