browserSiteList: publish

Namespace: microsoft.graph

Publish the specified browserSiteList for devices to download.

This API is supported in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	BrowserSiteLists.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	BrowserSiteLists.ReadWrite.All

HTTP request

POST /admin/edge/internetExplorerMode/siteLists/{browserSiteListId}/publish

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, omit both sites and shared cookies to publish the entire site list. Optionally, you can publish specific sites and shared cookies by specifying a collection of IDs.

Property	Type	Description
revision	String	The revision of the site list to publish. Required.
sharedCookies	browserSharedCookie collection	The collection of shared cookies to publish. Optional. Only requires the shared cookie ID. All other fields are ignored.
sites	browserSite collection	The collection of sites to publish. Optional. Only requires the site ID. All other fields are ignored.

Response

If successful, this action returns a 200 OK response code and a browserSiteList in the response body.

Examples

Example 1: Publish all sites and shared cookies

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/v1.0/admin/edge/internetExplorerMode/siteLists/36ba61eb-c492-4283-a38b-963a1dbb2f69/publish
Content-Type: application/json

{
    "revision": "1.0"
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Admin.Edge.InternetExplorerMode.SiteLists.Item.Publish.PublishPostRequestBody
{
	Revision = "1.0",
};
var result = await graphClient.Admin.Edge.InternetExplorerMode.SiteLists["{browserSiteList-id}"].Publish.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc admin edge internet-explorer-mode site-lists publish post --browser-site-list-id {browserSiteList-id} --body '{\
    "revision": "1.0"\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphadmin "github.com/microsoftgraph/msgraph-sdk-go/admin"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphadmin.NewPublishPostRequestBody()
revision := "1.0"
requestBody.SetRevision(&revision) 

publish, err := graphClient.Admin().Edge().InternetExplorerMode().SiteLists().ByBrowserSiteListId("browserSiteList-id").Publish().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String revision = "1.0";

graphClient.admin().edge().internetExplorerMode().siteLists("36ba61eb-c492-4283-a38b-963a1dbb2f69")
	.publish(BrowserSiteListPublishParameterSet
		.newBuilder()
		.withRevision(revision)
		.withSites(null)
		.withSharedCookies(null)
		.build())
	.buildRequest()
	.post();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const browserSiteList = {
    revision: '1.0'
};

await client.api('/admin/edge/internetExplorerMode/siteLists/36ba61eb-c492-4283-a38b-963a1dbb2f69/publish')
	.post(browserSiteList);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PublishPostRequestBody();
$requestBody->setRevision('1.0');

$result = $graphServiceClient->admin()->edge()->internetExplorerMode()->siteLists()->byBrowserSiteListId('browserSiteList-id')->publish()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)

request_body = PublishPostRequestBody(
	revision = "1.0",
)

result = await graph_client.admin.edge.internet_explorer_mode.site_lists.by_site_list_id('browserSiteList-id').publish.post(body = request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.browserSiteList",
    "id": "36ba61eb-c492-4283-a38b-963a1dbb2f69",
    "revision": "1.0",
    "displayName": "Product Site List A",
    "description": "A production site list for team A",
    "lastModifiedDateTime": "2022-06-28T19:29:52.8752365Z",
    "publishedDateTime": "2022-06-28T19:29:52.8752365Z",
    "status": "published",
    "lastModifiedBy": {
        "user": {
            "id": "f6ff107e-bc40-4918-a432-8d7b60030a7c",
            "displayName": "Joe Smith"
        },
        "application": null
    },
    "publishedBy": {
        "user": {
            "id": "f6ff107e-bc40-4918-a432-8d7b60030a7c",
            "displayName": "Joe Smith"
        },
        "application": null
    }
}

Example 2: Publish specific sites and shared cookies

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/v1.0/admin/edge/internetExplorerMode/siteLists/36ba61eb-c492-4283-a38b-963a1dbb2f69/publish
Content-Type: application/json

{
    "revision": "1.0",
    "sites": [
        {
            "id": "53e5f971-fc7b-4cd3-a1bf-34d7c0416882"
        },
        {
            "id": "2e27cc86-3662-447e-b751-274fb9f869ea"
        }
    ],
    "sharedCookies": [
        {
            "id": "7f639835-23ab-4793-b1e6-1a06fad127a2"
        }
    ]
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Admin.Edge.InternetExplorerMode.SiteLists.Item.Publish.PublishPostRequestBody
{
	Revision = "1.0",
	Sites = new List<BrowserSite>
	{
		new BrowserSite
		{
			Id = "53e5f971-fc7b-4cd3-a1bf-34d7c0416882",
		},
		new BrowserSite
		{
			Id = "2e27cc86-3662-447e-b751-274fb9f869ea",
		},
	},
	SharedCookies = new List<BrowserSharedCookie>
	{
		new BrowserSharedCookie
		{
			Id = "7f639835-23ab-4793-b1e6-1a06fad127a2",
		},
	},
};
var result = await graphClient.Admin.Edge.InternetExplorerMode.SiteLists["{browserSiteList-id}"].Publish.PostAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc admin edge internet-explorer-mode site-lists publish post --browser-site-list-id {browserSiteList-id} --body '{\
    "revision": "1.0",\
    "sites": [\
        {\
            "id": "53e5f971-fc7b-4cd3-a1bf-34d7c0416882"\
        },\
        {\
            "id": "2e27cc86-3662-447e-b751-274fb9f869ea"\
        }\
    ],\
    "sharedCookies": [\
        {\
            "id": "7f639835-23ab-4793-b1e6-1a06fad127a2"\
        }\
    ]\
}\
'

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphadmin "github.com/microsoftgraph/msgraph-sdk-go/admin"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphadmin.NewPublishPostRequestBody()
revision := "1.0"
requestBody.SetRevision(&revision) 


browserSite := graphmodels.NewBrowserSite()
id := "53e5f971-fc7b-4cd3-a1bf-34d7c0416882"
browserSite.SetId(&id) 
browserSite1 := graphmodels.NewBrowserSite()
id := "2e27cc86-3662-447e-b751-274fb9f869ea"
browserSite1.SetId(&id) 

sites := []graphmodels.browserSiteable {
	browserSite,
	browserSite1,
}
requestBody.SetSites(sites)


browserSharedCookie := graphmodels.NewBrowserSharedCookie()
id := "7f639835-23ab-4793-b1e6-1a06fad127a2"
browserSharedCookie.SetId(&id) 

sharedCookies := []graphmodels.browserSharedCookieable {
	browserSharedCookie,
}
requestBody.SetSharedCookies(sharedCookies)

publish, err := graphClient.Admin().Edge().InternetExplorerMode().SiteLists().ByBrowserSiteListId("browserSiteList-id").Publish().Post(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String revision = "1.0";

LinkedList<BrowserSite> sitesList = new LinkedList<BrowserSite>();
BrowserSite sites = new BrowserSite();
sites.id = "53e5f971-fc7b-4cd3-a1bf-34d7c0416882";

sitesList.add(sites);
BrowserSite sites1 = new BrowserSite();
sites1.id = "2e27cc86-3662-447e-b751-274fb9f869ea";

sitesList.add(sites1);
BrowserSiteCollectionResponse browserSiteCollectionResponse = new BrowserSiteCollectionResponse();
browserSiteCollectionResponse.value = sitesList;
BrowserSiteCollectionPage browserSiteCollectionPage = new BrowserSiteCollectionPage(browserSiteCollectionResponse, null);

LinkedList<BrowserSharedCookie> sharedCookiesList = new LinkedList<BrowserSharedCookie>();
BrowserSharedCookie sharedCookies = new BrowserSharedCookie();
sharedCookies.id = "7f639835-23ab-4793-b1e6-1a06fad127a2";

sharedCookiesList.add(sharedCookies);
BrowserSharedCookieCollectionResponse browserSharedCookieCollectionResponse = new BrowserSharedCookieCollectionResponse();
browserSharedCookieCollectionResponse.value = sharedCookiesList;
BrowserSharedCookieCollectionPage browserSharedCookieCollectionPage = new BrowserSharedCookieCollectionPage(browserSharedCookieCollectionResponse, null);

graphClient.admin().edge().internetExplorerMode().siteLists("36ba61eb-c492-4283-a38b-963a1dbb2f69")
	.publish(BrowserSiteListPublishParameterSet
		.newBuilder()
		.withRevision(revision)
		.withSites(sitesList)
		.withSharedCookies(sharedCookiesList)
		.build())
	.buildRequest()
	.post();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const browserSiteList = {
    revision: '1.0',
    sites: [
        {
            id: '53e5f971-fc7b-4cd3-a1bf-34d7c0416882'
        },
        {
            id: '2e27cc86-3662-447e-b751-274fb9f869ea'
        }
    ],
    sharedCookies: [
        {
            id: '7f639835-23ab-4793-b1e6-1a06fad127a2'
        }
    ]
};

await client.api('/admin/edge/internetExplorerMode/siteLists/36ba61eb-c492-4283-a38b-963a1dbb2f69/publish')
	.post(browserSiteList);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new PublishPostRequestBody();
$requestBody->setRevision('1.0');
$sitesBrowserSite1 = new BrowserSite();
$sitesBrowserSite1->setId('53e5f971-fc7b-4cd3-a1bf-34d7c0416882');
$sitesArray []= $sitesBrowserSite1;
$sitesBrowserSite2 = new BrowserSite();
$sitesBrowserSite2->setId('2e27cc86-3662-447e-b751-274fb9f869ea');
$sitesArray []= $sitesBrowserSite2;
$requestBody->setSites($sitesArray);

$sharedCookiesBrowserSharedCookie1 = new BrowserSharedCookie();
$sharedCookiesBrowserSharedCookie1->setId('7f639835-23ab-4793-b1e6-1a06fad127a2');
$sharedCookiesArray []= $sharedCookiesBrowserSharedCookie1;
$requestBody->setSharedCookies($sharedCookiesArray);


$result = $graphServiceClient->admin()->edge()->internetExplorerMode()->siteLists()->byBrowserSiteListId('browserSiteList-id')->publish()->post($requestBody)->wait();

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(request_adapter)

request_body = PublishPostRequestBody(
	revision = "1.0",
	sites = [
		BrowserSite(
			id = "53e5f971-fc7b-4cd3-a1bf-34d7c0416882",
		),
		BrowserSite(
			id = "2e27cc86-3662-447e-b751-274fb9f869ea",
		),
	]
	shared_cookies = [
		BrowserSharedCookie(
			id = "7f639835-23ab-4793-b1e6-1a06fad127a2",
		),
	]
)

result = await graph_client.admin.edge.internet_explorer_mode.site_lists.by_site_list_id('browserSiteList-id').publish.post(body = request_body)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response. The status will show pending if the request contains sites or shared cookies that you have not published yet.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.browserSiteList",
    "id": "36ba61eb-c492-4283-a38b-963a1dbb2f69",
    "revision": "1.0",
    "displayName": "Product Site List A",
    "description": "A production site list for team A",
    "lastModifiedDateTime": "2022-06-28T19:29:52.8752365Z",
    "publishedDateTime": "2022-06-28T19:29:52.8752365Z",
    "status": "pending",
    "lastModifiedBy": {
        "user": {
            "id": "f6ff107e-bc40-4918-a432-8d7b60030a7c",
            "displayName": "Joe Smith"
        },
        "application": null
    },
    "publishedBy": {
        "user": {
            "id": "f6ff107e-bc40-4918-a432-8d7b60030a7c",
            "displayName": "Joe Smith"
        },
        "application": null
    }
}