Office 365 でサイト コレクションに外部共有を設定する
Office 365 の SharePoint サイト コレクションに対する外部共有の設定を制御すると、外部ユーザー (Office 365 サブスクリプションの組織アカウントを持っていないユーザー) が組織のサイト コレクションにアクセスできるようになります。
適用対象: SharePoint 用アドイン | SharePoint Online | Office 365
Core.ExternalSharing コード サンプルは、SharePoint サイト コレクションに対する外部共有の設定を制御する方法を示しています。 このソリューションは、次の目的で使用します。
サイトのプロビジョニング プロセス中に外部共有の設定を制御します。
外部ユーザーと共有するようにサイト コレクションを準備します。
注:
外部共有の設定は、Office 365 でのみ利用可能です。
はじめに
まず、 Core.ExternalSharing サンプル アドインを、GitHub の Office 365 Developer Patterns and Practices プロジェクトからダウンロードします。
Core.ExternalSharing アプリを使用する
組織の Office 365 サブスクリプションで外部共有が許可されていることを確認します。 これを行うには、次の手順を実行します。
Office 365管理センターを開きます。
左側のナビゲーション メニューで、[SharePoint] を選択します。
左側のナビゲーション メニューで、[ 共有] を選択します。
[organizationの外部で共有する] で、[認証された外部ユーザーとの招待と共有をユーザーに許可する] が [オン] になっていることを確認します。
SharePoint サイト コレクションに対する外部サイトの設定を確認します。 これを行うには、次の手順を実行します。
Office 365管理センターを開きます。
左側のナビゲーション メニューで、[ SharePoint ] を選択して SharePoint 管理センターを開きます。
サイト コレクションのリストで、外部共有設定を確認する対象のサイト コレクションの URL の横にあるチェック ボックスをオンにします。
リボンで、[共有] を選択します。
共有 ダイアログで 外部共有設定を確認します。 コード サンプルを実行した後、 [共有] ダイアログに戻り、外部共有の設定が変更されたことを確認します。
このコード サンプルを実行すると、Program.cs の "Main" によって次のタスクが実行されます。
SharePoint 管理センターの URL を取得する
外部共有の設定をオンに構成するサイト コレクションの URL を取得します。
Office 365 管理者の資格情報を取得します。
GetInputSharing を呼び出します。これにより、サイト コレクションに適用する外部共有設定 (SharingCapabilities) を選択するようにユーザーに求められます。 外部共有の設定の選択肢は次のとおりです。
Disabled。サイトに対する外部共有をオフにします。
ExternalUserAndGuestSharing。外部ユーザーとゲストがサイトを共有できるようにします。
ExternalUserSharingOnly。外部ユーザーとの共有のみを有効にします。
SetSiteSharing を呼び出します。
注:
この記事で提供されるコードは、明示または黙示のいかなる種類の保証なしに現状のまま提供されるものであり、特定目的への適合性、商品性、権利侵害の不存在についての暗黙的な保証は一切ありません。
static void Main(string[] args)
{
/* Prompt for your Office 365 admin center URL*/
Console.WriteLine("Enter your Tenant Admin URL for your Office 365 subscription:");
string tenantAdminURL = GetSite();
/* End Program if no Office 365 admin center URL is supplied*/
if (string.IsNullOrEmpty(tenantAdminURL))
{
Console.WriteLine("Hmm, i tried to work on it but you didn't supply your admin tenant url:");
return;
}
// Prompt the user for an Office365 site collection
Console.WriteLine("Enter your Office 365 Site Collection URL:");
string siteUrl = GetSite();
/* Prompt for Credentials */
Console.WriteLine("Enter Credentials for your Office 365 Site Collection {0}:", siteUrl);
string userName = GetUserName();
SecureString pwd = GetPassword();
/* End program if no credentials are entered */
if (string.IsNullOrEmpty(userName) || (pwd == null))
{
Console.WriteLine("Hmm, i tried to work on it but you didn't supply your credentials:");
return;
}
try
{
SharingCapabilities _sharingSettingToApply = GetInputSharing(siteUrl);
using (ClientContext cc = new ClientContext(tenantAdminURL))
{
cc.AuthenticationMode = ClientAuthenticationMode.Default;
cc.Credentials = new SharePointOnlineCredentials(userName, pwd);
SetSiteSharing(cc, siteUrl, _sharingSettingToApply);
}
}
catch(Exception ex)
{
Console.WriteLine("Oops, Mistakes can happen to anyone. An Error occured : {0}", ex.Message);
}
Console.WriteLine("Hit Enter to exit.");
Console.Read();
}
SetSiteSharing は、以下の処理を実行します。
Tenant.GetSitePropertiesByUrl を使用して、サイト コレクションの SiteProperties を取得します。
Tenant.SharingCapability を使用して、Office 365 サブスクリプションで外部共有が有効になっているかどうかを判断します。
Office 365 サブスクリプションで共有が有効になっている場合は、SiteProperties.SharingCapability の設定を、ユーザーが入力した外部共有の設定にします。
public static void SetSiteSharing(ClientContext adminCC, string siteCollectionURl, SharingCapabilities shareSettings)
{
var _tenantAdmin = new Tenant(adminCC);
SiteProperties _siteprops = _tenantAdmin.GetSitePropertiesByUrl(siteCollectionURl, true);
adminCC.Load(_tenantAdmin);
adminCC.Load(_siteprops);
adminCC.ExecuteQuery();
SharingCapabilities _tenantSharing = _tenantAdmin.SharingCapability;
var _currentShareSettings = _siteprops.SharingCapability;
bool _isUpdatable = false;
if(_tenantSharing == SharingCapabilities.Disabled)
{
Console.WriteLine("Sharing is currently disabled in your tenant! I am unable to work on it.");
}
else
{
if(shareSettings == SharingCapabilities.Disabled)
{ _isUpdatable = true; }
else if(shareSettings == SharingCapabilities.ExternalUserSharingOnly)
{
_isUpdatable = true;
}
else if (shareSettings == SharingCapabilities.ExternalUserAndGuestSharing)
{
if (_tenantSharing == SharingCapabilities.ExternalUserAndGuestSharing)
{
_isUpdatable = true;
}
else
{
Console.WriteLine("ExternalUserAndGuestSharing is currently disabled in your tenant! I am unable to work on it.");
}
}
}
if (_currentShareSettings != shareSettings && _isUpdatable)
{
_siteprops.SharingCapability = shareSettings;
_siteprops.Update();
adminCC.ExecuteQuery();
Console.WriteLine("Set Sharing on site {0} to {1}.", siteCollectionURl, shareSettings);
}
}