Set-SPOTenantPreAuthSettings
事前認証の構成を設定します。
構文
IsDisabled
Set-SPOTenantPreAuthSettings
-IsDisabled <Boolean>
[<CommonParameters>]
AddListItem
Set-SPOTenantPreAuthSettings
-Type <TenantPreAuthSettingsListType>
[-Add]
[-IncludedApps <String>]
[-ExcludedApps <String>]
[-IncludedFeatures <String>]
[-ExcludedFeatures <String>]
[<CommonParameters>]
RemoveListItem
Set-SPOTenantPreAuthSettings
-Id <String>
[-Remove]
[<CommonParameters>]
UseGraphUrlSettings
Set-SPOTenantPreAuthSettings
[-UseGraphUrlIsEnabled <Boolean>]
[-UseGraphUrlAppsList <String>]
[<CommonParameters>]
説明
このコマンドレットを使用して、SharePoint Online 内の事前認証機能を構成または無効にできます。 無効化をスイッチと組み合わせて、テナント レベルで特定のアプリや機能のきめ細かな認証前管理をサポートできます。
注:
事前認証とは
SharePoint には、事前認証 URL (一時認証 URL とも呼ばれます) と呼ばれる URL に自己発行トークンが含まれており、SharePoint リソースへの一時的なアクセスを提供し、より充実したユーザー エクスペリエンスをサポートするのに役立ちます。 たとえば、一般的なシナリオでは、次のような tempauth クエリ パラメーターにトークンを含む URL を使用してファイルをダウンロードします。
https://<tenant>.sharepoint.com/sites/samplesite/_layouts/15/download.aspx?UniqueId=<id>&tempauth=v1.ey...
ただし、この機能は現在非推奨となっているため、このコマンドレットを使用すると、さまざまなユース ケースで事前認証の使用を制御できます。
重要
設定には以下のような優先順位が設定されます。
- 拒否
- 許可
- IsDisabled
さらに、このコマンドレットを使用すると SharePoint Online テナントの機能が無効になる可能性があるため、運用環境で変更を加える前に、テスト テナントで各変更をテストして評価することを 強くお勧め します。
コマンドレットを実行するには、SharePoint 管理者である必要があります。
Microsoft Graph の URL 設定
Microsoft Graph ファイル API は、アプリケーションがファイル操作のダウンロード、アップロード、プレビュー、変換、または監視に使用する URL を返すことができます。 これらの URL の中には、これまで事前認証トークンが含まれていたり、クライアントを事前認証された URL にリダイレクトしたりするものがあります。
このコマンドレットを使用して、サード パーティ製アプリケーションのサポートされている API からの Microsoft Graph URL の受信を開始できます。
予期される API の動作
URL を返す API
Microsoft Graph の代替を使用する API の場合、呼び出し元のアプリケーションに対して設定が有効になっている場合、応答では Microsoft Graph URL が使用され、アプリケーションは適切な Microsoft Graph アクセス トークンを使用してその URL を呼び出すことができます。
代替 Microsoft Graph がない API の場合、返される SharePoint Online URL には一時的な認証情報は含まれません。 アプリケーションは、SharePoint Online 用の適切な Microsoft Entra アクセス トークンを取得し、返された URL を呼び出すときに含める必要があります。
現在 HTTP 302 リダイレクトを返している API
影響を受ける API は、アプリケーションを一時的な認証 URL にリダイレクトするのではなく、コンテンツを直接返します。 アプリケーションは、リダイレクトのインターセプト、リダイレクトの場所からの一時的な認証値の抽出、リダイレクトされた URL を未認証のクライアントに渡すこと、またはすべてのコンテンツ要求が HTTP 302 ステータス コードを返すものであると想定することに依存してはなりません。 アプリケーションは、元の Microsoft Graph 要求からのコンテンツ応答が成功した場合を処理するために準備しておく必要があります。
SharePoint API の直接要求
テナント設定は、元の要求が Microsoft Graph を介して行われた場合に適用されます。 アプリケーションが SharePoint API に対して直接行う要求を変更することはありません。
影響を受ける API シナリオ
| API シナリオ | 予期せぬ動作 |
|---|---|
| ドライブの項目とお子様の応答 | 構成されたアプリケーションは、サポートされている場合、Microsoft Graph contentStream URL を受け取ります。 |
| ドライブのアイテム/コンテンツ | コンテンツは、一時的な認証 URL への HTTP 302 リダイレクトを介さずに直接返されます。 |
| ドライブ項目 /contentStream | 変更は想定されていません。 |
| ドライブ アイテム バージョン | 構成されたアプリケーションは、サポートされている場合、現在および以前のバージョンの Microsoft Graph コンテンツ URL を受け取ります。 |
| バージョン/コンテンツ | コンテンツは、HTTP 302 リダイレクトを介さずに直接返されます。 |
| アップロード セッションを作成する | 返される SharePoint Online アップロード URL に一時的な認証情報が含まれていません。 アプリケーションは、SharePoint Online に対して認証する必要があります。 |
| コピー操作 | モニター URL には、一時的な認証情報は含まれていません。 アプリケーションは、SharePoint Online URL をポーリングするときに認証する必要があります。 |
| Preview | プレビュー URL には、一時的な認証情報は含まれていません。 アプリケーションは、SharePoint Online に対して認証する必要があります。 |
| サムネイル | 構成されたアプリケーションは、サポートされている場合、Microsoft Graph サムネイル コンテンツの URL を受け取ります。 |
| サムネイル コンテンツ | コンテンツは、一時的な認証 URL への HTTP 302 リダイレクトを介さずに直接返されます。 |
| 形式の変換 | 変換されたコンテンツは、API の可用性により、HTTP 302 リダイレクトの代わりに直接返されます。 |
例
例 1
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
この例では、事前認証を全体的に無効にし、2 つのアプリがすべての機能で事前認証を使用できるようにする設定を追加します。
例 2
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e" -ExcludedApps "" -IncludedFeatures "" -ExcludedFeatures ""
この例では例 1 と同じ機能を実行しますが、この場合は -ExcludedApps、 -IncludedFeatures、および -ExcludedFeatures のスイッチがコマンドレットに追加されます。
これらのスイッチは、コマンドレットで使用しない場合、既定値の "" を使用すると見なされます。例 2 は、スイッチの完全なセットを示すためにのみ使用します。
例 3
Set-SPOTenantPreAuthSettings -Remove -Id "368dde6f-c857-4383-a8a7-02a04a294e6d"
この例では、現在のアイテム リストから既存のアイテムを削除します。 削除スイッチを使用すると、許可または拒否のエントリを一覧から削除できます。
例 4
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -ExcludedFeatures "Download,WebRenderingEmbed"
この例では、事前認証を全体的に無効にし、1 つのアプリを除くすべてのアプリが "Download" と "WebRenderingEmbed" を除くすべての機能で事前認証を使用できるようにします。
この場合、アプリ "029e7c27-4b9c-4f8b-ba32-b96249468d42" は許可リスト設定から除外されるため、事前認証の使用は常に拒否されます。 他のアプリは、 "Download" と "WebRenderingEmbed" 以外のすべての機能に事前認証を使用できます。
例 5
Set-SPOTenantPreAuthSettings -IsDisabled $true
Set-SPOTenantPreAuthSettings -Add -Type Allow -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" -IncludedFeatures "OfficeOnline,WebRenderingEmbed,Download"
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
この例では事前認証を全体的に無効にしますが、[許可] リストと拒否リストの設定が重複しています。 最初に、アプリが "OfficeOnline"、 "WebRenderingEmbed"、 "Download" 機能に事前認証を使用することを許可します。 ただし、コマンドレットの最終的な実行では、同じアプリがすべての機能で事前認証を使用することが拒否されます。
この場合、アプリ "029e7c27-4b9c-4f8b-ba32-b96249468d42" は、設定があるにもかかわらず、許可リストに登録されている機能に対して事前認証を使用することを許可されません。 これは、拒否リストが許可リストよりも優先されるためです。
例 6
Set-SPOTenantPreAuthSettings -IsDisabled $false
Set-SPOTenantPreAuthSettings -Add -Type Deny -IncludedApps "Empty"
この例では、事前認証を全体的に有効にし、アプリからではない要求 (ブラウザー経由の要求など) がすべての機能で事前認証を使用することを拒否します。
注:
-IncludedApps または -ExcludedApps の"Empty"値は、空の文字列""とは異なります。 ルールは次のとおりです。
-
"Empty"アプリからではなく、アプリ ID が関連付けられていない要求を表します -
""意味は次のとおりです。-
–IncludedApps "" -ExcludedApps ""がある場合は、設定がすべての -
–IncludedApps "" -ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42"がある場合は、設定が"029e7c27-4b9c-4f8b-ba32-b96249468d42"以外のすべてのアプリに適用されます。 -
–IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" and -ExcludedApps ""がある場合は、設定がアプリにのみ適用されることを意味します"029e7c27-4b9c-4f8b-ba32-b96249468d42" - 使用できる
–IncludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42" –ExcludedApps "029e7c27-4b9c-4f8b-ba32-b96249468d42"
-
例 7
Set-SPOTenantPreAuthSettings -UseGraphUrlIsEnabled $true -UseGraphUrlAppsList "029e7c27-4b9c-4f8b-ba32-b96249468d42,0ab82eba-96c7-4681-9f75-c18437e20d0e"
この例では、2 つのアプリの設定を有効にします。つまり、サポートされている Microsoft Graph API は、これらのアプリに Graph URL を返します。 ターゲット リストを使用すると、動作をより広範に適用する前にアプリケーションの互換性を検証できます。
例 8
Set-SPOTenantPreAuthSettings -UseGraphUrlIsEnabled $true -UseGraphUrlAppsList ""
この例では、空のアプリケーション リストを指定することで、すべての 3P アプリケーションの設定を有効にします。
例 9
Set-SPOTenantPreAuthSettings -UseGraphUrlIsEnabled $false
この例では、この設定を使用して Microsoft Graph URL の返品を停止する方法を示します。
パラメーター
-Add
このパラメーターは、コマンドレットの操作が許可リストまたは拒否リストに設定を追加することを指定します。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExcludedApps
このパラメーター値には、 -ExcludedApps スコープ内で構成するアプリ ID が含まれます。 指定できる値は、 ""、 "Empty"、またはアプリ ID のコンマ区切りのリストです。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ExcludedFeatures
このパラメーター値には、 -ExcludedFeatures スコープ内で構成する機能名が含まれます。 使用可能な値は、 "" または機能名のコンマ区切りのリスト (以下の「注」セクションを参照) です。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
このパラメーターは、現在の構成から削除するリスト項目の設定を識別します。
-Remove パラメーターでのみ必要です。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RemoveListItem
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IncludedApps
このパラメーター値には、 -IncludedApps スコープ内で構成するアプリ ID が含まれます。 指定できる値は、 ""、 "Empty"、またはアプリ ID のコンマ区切りのリストです。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IncludedFeatures
このパラメーター値には、 -IncludedFeatures スコープ内で構成する機能名が含まれます。 使用可能な値は、 "" または機能名のコンマ区切りのリスト (以下の「注」セクションを参照) です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-IsDisabled
このパラメーターを使用すると、管理者はすべてのアプリと機能の事前認証を有効または無効に切り替えることができます。
パラメーターのプロパティ
| 型: | Boolean |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
IsDisabled
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Remove
このパラメーターは、コマンドレットの操作が許可リストまたは拒否リストから設定を削除することを指定します。
パラメーターのプロパティ
| 型: | System.Management.Automation.SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
RemoveListItem
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Type
このパラメーターは、コマンドレットが許可リストと拒否リストのどちらを操作しているかを示します。
パラメーターのプロパティ
| 型: | TenantPreAuthSettingsListType |
| 規定値: | None |
| 指定可能な値: | Allow, Deny |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
AddListItem
| 配置: | Named |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseGraphUrlAppsList
新しい動作を受け取る Microsoft Entra アプリケーション ID が含まれています。 空の文字列は、設定がすべてのアプリケーションに適用することを意味します。 これは、 -UseGraphUrlIsEnabled が $true に設定されている場合にのみ適用されます。
パラメーターのプロパティ
| 型: | System.String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UseGraphUrlSettings
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-UseGraphUrlIsEnabled
サポートされている API が構成されたアプリケーションに Microsoft Graph URL を返すことができるかどうかを決定します。
パラメーターのプロパティ
| 型: | System.Boolean |
| 規定値: | None |
| 指定可能な値: | True, False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
UseGraphUrlSettings
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、「about_CommonParameters」を参照してください。
入力
None
出力
System.Object
メモ
-IncludedFeaturesと-ExcludedFeaturesでは、次の表の機能名が使用されます。 PowerShell コマンドレットを使用して無効にした場合に機能が壊れるかどうかについて明示的に言及しています。
| 機能名 | 説明 | その他の情報 |
|---|---|---|
| DataFormWebpart | SharePoint データを表示/操作するために DataFormWebParts に関連するシナリオ。 | DataFormWebPart プロパティ (Microsoft.SharePoint.WebPartPages) - Microsoft Learn |
| ダウンロード | 事前認証されたダウンロード URL を取得するためのシナリオ。 サード パーティ製アプリケーションと一部のファースト パーティ製アプリケーションが壊れている可能性があります。 | Microsoft ID プラットフォームでの OAuth 2.0 および OpenID Connect プロトコル - Microsoft Learn |
| OfficeOnline | Office on the web シナリオ。 パフォーマンスが影響を受ける可能性があります。 | |
| SearchPreview | 検索クエリ結果のプレビュー/サムネイル/コンバージョンの生成に関連するシナリオ。 エクスペリエンスが壊れている可能性があります。 | |
| SharePointConnector | SharePoint コネクタに関連するシナリオ | SharePoint コネクタ - Microsoft Learn |
| サムネイル | 事前認証されたサムネイル生成 URL を取得するためのシナリオ。 | |
| UploadSession | アップロード セッションを作成するためのシナリオ。 サード パーティのアプリケーションと一部のファースト パーティ アプリケーションが壊れている可能性があります | |
| ビデオ | 再生中 SharePoint でホストされているビデオが壊れている可能性があります | |
| WebRendering | ブラウザーでファイルのプレビューをレンダリングするシナリオ。 | |
| WebRenderingEmbed | 別のアプリケーションに SharePoint ファイルを埋め込む。 サード パーティのアプリケーションと一部のファースト パーティ アプリケーションが壊れている可能性があります | Web パーツを埋め込む |
| Whiteboard | Teams と Whiteboard アプリの統合は、匿名ユーザーとゲスト ユーザーに対しては機能しなくなります。 | Teams 会議で Whiteboard を使用する - Microsoft サポート |