OnlineIdServiceTicketRequest クラス

定義

名前空間:

Windows.Security.Authentication.OnlineId

アプリが、Id プロパティとチケットを取得するためにライブ ユーザーの認証に使用されるサービスとポリシーを指定する機能を提供します。

注意

Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

public ref class OnlineIdServiceTicketRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
/// [Windows.Foundation.Metadata.Activatable(Windows.Security.Authentication.OnlineId.IOnlineIdServiceTicketRequestFactory, 65536, "Windows.Foundation.UniversalApiContract")]
class OnlineIdServiceTicketRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Activatable(typeof(Windows.Security.Authentication.OnlineId.IOnlineIdServiceTicketRequestFactory), 65536, "Windows.Foundation.UniversalApiContract")]
public sealed class OnlineIdServiceTicketRequest

function OnlineIdServiceTicketRequest(service, policy)

Public NotInheritable Class OnlineIdServiceTicketRequest

継承

Object Platform::Object IInspectable OnlineIdServiceTicketRequest

属性

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows の要件

デバイス ファミリ	Windows 10 (10.0.10240.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v1.0 で導入)

例

次の例は、Live ユーザーの認証に使用されるサービスとポリシーを指定する方法を示しています。

function signIn() {
    var authenticator = new Windows.Security.Authentication.OnlineId.OnlineIdAuthenticator();
    var serviceTicketRequest = new Windows.Security.Authentication.OnlineId.OnlineIdServiceTicketRequest(
        "wl.basic wl.contacts_photos wl.calendars", "DELEGATION");

    sdkSample.displayStatus("Signing in...");

    authenticator.authenticateUserAsync(serviceTicketRequest)
        .done(function (authResult) {

            if ((authResult.tickets.size == 1) && (authResult.tickets[0].errorCode == 0)) {
                sdkSample.isSignedIn = true;
                sdkSample.displayStatus("Authorization succeeded.");
                sdkSample.accessToken = authResult.tickets[0];
                sdkSample.canSignOut = authenticator.canSignOut;
            }
        },

            function (authStatus) {
                if (authStatus && (authStatus.name !== "Canceled")) {
                    showErrorMessage("Autorization failed: " + authStatus.message);
                } else {
                    sdkSample.displayStatus("");
                }
                    showAccountStatus();
                });
}

コンストラクター

OnlineIdServiceTicketRequest(String)	OnlineIdServiceTicketRequest クラスのインスタンスを作成します。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。
OnlineIdServiceTicketRequest(String, String)	OnlineIdServiceTicketRequest クラスのインスタンスを作成します。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

プロパティ

Policy

ユーザーの認証に使用されるポリシー。 サポートされている値は JWT であり、JSON 形式を使用してデータを返します。 Live に格納されているアクセスに対するユーザーの同意を要求しているアプリの場合、アプリ開発者は DELEGATION のポリシーに合格する必要があります。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。

Service

アプリで使用するサービスを識別します。 サービス名は、 にアプリ http://go.microsoft.com/fwlink/p/?linkid=241860を登録するときに指定した DNS 名と一致する必要があります。 チケットはこのサービスに対してのみ発行されます。 Live に格納されているアクセスに対するユーザーの同意を要求しているアプリの場合は、アプリがアクセスを必要とするオファーを渡す必要があります。 利用可能なオファーの一覧は、 スコープとアクセス許可に関する ページで確認できます。 その後、チケットを Live Connect REST API と共に使用して、ユーザーがアプリに渡すために同意したデータにアクセスできます。 詳細については、 REST API に関 するトピックを参照してください。 または、アプリで Live Connect SDK を使用して、これらの呼び出し自体を行うことができます。 注意 Windows 10以上の開発を行う場合は、代わりに Windows.Security.Authentication.Web.Core API を使用してください。 詳細については、「 Web アカウント マネージャー」を参照してください。