Apple SSO クックブック（REST API V2） apple-sso-cookbook-rest-api-v2

• software_statement のようなすべての 必須 パラメーター
• Content-Type、X-Device-Info などのすべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。

• client_id、client_secret、grant_type など、すべての 必須 パラメーター
• Content-Type、X-Device-Info などのすべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。

• ストリーミングアプリケーションは、ユーザーの購読情報 ​ アクセス権限 ​ を確認し、ユーザーが許可した場合にのみ続行する必要があります。
• ストリーミングアプリケーションは、VSAccountManager に ​ デリゲート ​ を提供する必要があります。
• ストリーミングアプリケーションは、購読者のアカウント情報用に ​ リクエスト ​ を送信する必要があります。
• ストリーミングアプリケーションは、​ メタデータ ​ 情報を待機して処理する必要があります。

...
let videoSubscriberAccountManager: VSAccountManager = VSAccountManager();

videoSubscriberAccountManager.checkAccessStatus(options: [VSCheckAccessOption.prompt: true]) { (accessStatus, error) -> Void in
         switch (accessStatus) {
         // The user allows the application to access subscription information.
         case VSAccountAccessStatus.granted:
                 // Construct the request for subscriber account information.
                 let vsaMetadataRequest: VSAccountMetadataRequest = VSAccountMetadataRequest();

                 // This is actually the SAML Issuer not the channel ID.
                 vsaMetadataRequest.channelIdentifier = "https://saml.sp.auth.adobe.com";

                 // This is the subscription account information needed at this step.
                 vsaMetadataRequest.includeAccountProviderIdentifier = true;

                 // This is the subscription account information needed at this step.
                 vsaMetadataRequest.includeAuthenticationExpirationDate = true;

                 // This is going to make the Video Subscriber Account Framework to refrain from prompting the user with the providers picker at this step.
                 vsaMetadataRequest.isInterruptionAllowed = false;

                 // Submit the request for subscriber account information - accountProviderIdentifier.
                 videoSubscriberAccountManager.enqueue(vsaMetadataRequest) { vsaMetadata, vsaError in
                     if (vsaMetadata != nil && vsaMetadata!.accountProviderIdentifier != nil) {
                         // The vsaMetadata!.authenticationExpirationDate will contain the expiration date for current authentication session.
                         // The vsaMetadata!.authenticationExpirationDate should be compared against current date.
                         ...
                         // The vsaMetadata!.accountProviderIdentifier will contain the provider identifier as it is known for the platform configuration.
                         // The vsaMetadata!.accountProviderIdentifier represents the platformMappingId in terms of Adobe Pass Authentication configuration.
                         ...
                         // The application must determine the MVPD id property value based on the platformMappingId property value obtained above.
                         // The application must use the MVPD id further in its communication with Adobe Pass Authentication services.
                         ...
                         // Continue with the "Retrieve profiles" step.
                         ...
                     } else {
                         // The user is not authenticated at platform level, continue with the "Retrieve profiles" step.
                         ...
                     }
                 }

         // The user has not yet made a choice or does not allow the application to access subscription information.
         default:
             // Continue with the "Retrieve profiles" step.
             ...
         }
}
...

• ​ プロファイルの取得 ​API

• ​ 特定の mvpd のプロファイルの取得 ​ API

• serviceProvider （または mvpd）など、すべての 必須 パラメーター
• Authorization、AP-Device-Identifier、AP-Partner-Framework-Status など、すべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• serviceProvider のようなすべての 必須 パラメーター
• Authorization、AP-Device-Identifier、X-Device-Info など、すべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。

• enablePlatformServices:MVPDが現在Appleのシングルサインオンをサポートしているかどうかを示します。
• displayInPlatformPicker:AppleピッカーでMVPDを表示できるかどうかを示します。
• boardingStatus:MVPDがAppleのシングルサインオンでオンボードされているかどうかを示します。

• ストリーミングアプリケーションは、ユーザーの購読情報 ​ アクセス権限 ​ を確認し、ユーザーが許可した場合にのみ続行する必要があります。
• ストリーミングアプリケーションは、VSAccountManager に ​ デリゲート ​ を提供する必要があります。
• ストリーミングアプリケーションは、購読者のアカウント情報用に ​ リクエスト ​ を送信する必要があります。
• ストリーミングアプリケーションは、​ メタデータ ​ 情報を待機して処理する必要があります。

 ...
 let videoSubscriberAccountManager: VSAccountManager = VSAccountManager();

 // This must be a class implementing the VSAccountManagerDelegate protocol.
 let videoSubscriberAccountManagerDelegate: VideoSubscriberAccountManagerDelegate = VideoSubscriberAccountManagerDelegate();

 videoSubscriberAccountManager.delegate = videoSubscriberAccountManagerDelegate;

 videoSubscriberAccountManager.checkAccessStatus(options: [VSCheckAccessOption.prompt: true]) { (accessStatus, error) -> Void in
             switch (accessStatus) {
             // The user allows the application to access subscription information.
             case VSAccountAccessStatus.granted:
                     // Construct the request for subscriber account information.
                     let vsaMetadataRequest: VSAccountMetadataRequest = VSAccountMetadataRequest();

                     // This is actually the SAML Issuer not the channel ID.
                     vsaMetadataRequest.channelIdentifier = "https://saml.sp.auth.adobe.com";

                     // This is the subscription account information needed at this step.
                     vsaMetadataRequest.includeAccountProviderIdentifier = true;

                     // This is the subscription account information needed at this step.
                     vsaMetadataRequest.includeAuthenticationExpirationDate = true;

                     // This is going to make the Video Subscriber Account Framework to prompt the user with the providers picker at this step.
                     vsaMetadataRequest.isInterruptionAllowed = true;

                     // This can be computed from the Configuration service response in order to filter the TV providers from the Apple picker.
                     vsaMetadataRequest.supportedAccountProviderIdentifiers = supportedAccountProviderIdentifiers;

                     // This can be computed from the Configuration service response in order to sort the TV providers from the Apple picker.
                     if #available(iOS 11.0, tvOS 11, *) {
                         vsaMetadataRequest.featuredAccountProviderIdentifiers = featuredAccountProviderIdentifiers;
                     }

                     // Submit the request for subscriber account information - accountProviderIdentifier.
                     videoSubscriberAccountManager.enqueue(vsaMetadataRequest) { vsaMetadata, vsaError in
                         if (vsaMetadata != nil && vsaMetadata!.accountProviderIdentifier != nil) {
                             // The vsaMetadata!.authenticationExpirationDate will contain the expiration date for current authentication session.
                             // The vsaMetadata!.authenticationExpirationDate should be compared against current date.
                             ...
                             // The vsaMetadata!.accountProviderIdentifier will contain the provider identifier as it is known for the platform configuration.
                             // The vsaMetadata!.accountProviderIdentifier represents the platformMappingId in terms of Adobe Pass Authentication configuration.
                             ...
                             // The application must determine the MVPD id property value based on the platformMappingId property value obtained above.
                             // The application must use the MVPD id further in its communication with Adobe Pass Authentication services.
                             ...
                             // Continue with the "Retrieve partner authentication request" step.
                             ...
                         } else {
                             // The user is not authenticated at platform level.
                             if (vsaError != nil) {
                                 // The application can check to see if the user selected a provider which is present in Apple picker, but the provider is not onboarded in platform SSO.
                                 if let error: NSError = (vsaError! as NSError), error.code == 1, let appleMsoId = error.userInfo["VSErrorInfoKeyUnsupportedProviderIdentifier"] as! String? {
                                     var mvpd: Mvpd? = nil;

                                     // The requestor.mvpds must be computed during the "Return configuration" step.
                                     for provider in requestor.mvpds {
                                         if provider.platformMappingId == appleMsoId {
                                             mvpd = provider;
                                             break;
                                         }
                                     }

                                     if mvpd != nil {
                                         // Continue with the "Proceed with basic authentication flow" step, but you can skip prompting the user with your MVPD picker and use the mvpd selection, therefore creating a better UX.
                                         ...
                                     } else {
                                         // Continue with the "Proceed with basic authentication flow" step.
                                         ...
                                     }
                                 } else {
                                     // Continue with the "Proceed with basic authentication flow" step.
                                     ...
                                 }
                             } else {
                                 // Continue with the "Proceed with basic authentication flow" step.
                                 ...
                             }
                         }
                     }

             // The user has not yet made a choice or does not allow the application to access subscription information.
             default:
                 // Continue with the "Proceed with basic authentication flow" step.
                 ...
             }
 }
 ...

• serviceProvider や partner など、すべての 必須 パラメーター
• Authorization、AP-Device-Identifier、Content-Type、X-Device-Info、AP-Partner-Framework-Status など、すべての 必須 ヘッダー
• すべての オプション ヘッダーとパラメーター

• required パラメーターおよびヘッダーは有効である必要があります。
• 指定した serviceProvider と mvpd の統合はアクティブである必要があります。

• Adobe Pass サーバーのパートナーのシングルサインオン設定が有効であり、有効である必要があります。
• AP-Partner-Framework-Status ヘッダーを介して受信したパートナーフレームワークステータスペイロードは、有効である必要があります。

• ストリーミングアプリケーションは、ユーザーの購読情報 ​ アクセス権限 ​ を確認し、ユーザーが許可した場合にのみ続行する必要があります。
• ストリーミングアプリケーションは、VSAccountManager に ​ デリゲート ​ を提供する必要があります。
• ストリーミングアプリケーションは、購読者のアカウント情報用に ​ リクエスト ​ を送信する必要があり、さらに、前の手順で取得したパートナー認証要求（SAML 要求）を含める必要があります。
• ストリーミングアプリケーションは、​ メタデータ ​ 情報を待機して処理する必要があります。

 ...
 let videoSubscriberAccountManager: VSAccountManager = VSAccountManager();

 videoSubscriberAccountManager.checkAccessStatus(options: [VSCheckAccessOption.prompt: true]) { (accessStatus, error) -> Void in
             switch (accessStatus) {
             // The user allows the application to access subscription information.
             case VSAccountAccessStatus.granted:
                     // Construct the request for subscriber account information.
                     let vsaMetadataRequest: VSAccountMetadataRequest = VSAccountMetadataRequest();

                     // This is actually the SAML Issuer not the channel ID.
                     vsaMetadataRequest.channelIdentifier = "https://saml.sp.auth.adobe.com";

                     // This is going to include subscription account information which should match the provider determined in a previous step.
                     vsaMetadataRequest.includeAccountProviderIdentifier = true;

                     // This is going to include subscription account information which should match the provider determined in a previous step.
                     vsaMetadataRequest.includeAuthenticationExpirationDate = true;

                     // This is going to make the Video Subscriber Account Framework to refrain from prompting the user with the providers picker at this step.
                     vsaMetadataRequest.isInterruptionAllowed = false;

                     // This are the user metadata fields expected to be available on a successful login and are determined from the Sessions SSO service. Look for the authenticationRequest > attributesNames associated with the provider determined in a previous step.
                     vsaMetadataRequest.attributeNames = attributesNames;

                     // This is the authenticationRequest > request field from Sessions SSO service.
                     vsaMetadataRequest.verificationToken = authenticationRequestPayload;

                     // Submit the request for subscriber account information.
                     videoSubscriberAccountManager.enqueue(vsaMetadataRequest) { vsaMetadata, vsaError in
                         if (vsaMetadata != nil && vsaMetadata!.samlAttributeQueryResponse != nil) {
                             var samlResponse: String? = vsaMetadata!.samlAttributeQueryResponse!;

                             // Remove new lines, new tabs and spaces.
                             samlResponse = samlResponse?.replacingOccurrences(of: "[ \\t]+", with: " ", options: String.CompareOptions.regularExpression);
                             samlResponse = samlResponse?.components(separatedBy: CharacterSet.newlines).joined(separator: "");
                             samlResponse = samlResponse?.trimmingCharacters(in: CharacterSet.whitespacesAndNewlines);

                             // Base64 encode.
                             samlResponse = samlResponse?.data(using: .utf8)?.base64EncodedString(options: []);

                             // URL encode. Please be aware not to double URL encode it further.
                             samlResponse = samlResponse?.addingPercentEncoding(withAllowedCharacters: CharacterSet.init(charactersIn: "!*'();:@&=+$,/?%#[]").inverted);

                             // Continue with the "Create and retrieve profile using partner authentication response" step.
                             ...
                         } else {
                             // Continue with the "Proceed with basic authentication flow" step.
                             ...
                         }
                     }

             // The user has not yet made a choice or does not allow the application to access subscription information.
             default:
                 // Continue with the "Proceed with basic authentication flow" step.
                 ...
             }
 }
 ...

• serviceProvider、partner、SAMLResponse など、すべての 必須 パラメーター
• Authorization、AP-Device-Identifier、Content-Type、X-Device-Info、AP-Partner-Framework-Status など、すべての 必須 ヘッダー
• すべての オプション ヘッダーとパラメーター

• required パラメーターおよびヘッダーは有効である必要があります。
• 指定した serviceProvider と mvpd の統合はアクティブである必要があります。

• Adobe Pass サーバーのパートナーのシングルサインオン設定が有効であり、有効である必要があります。
• AP-Partner-Framework-Status ヘッダーを介して受信したパートナーフレームワークステータスペイロードは、有効である必要があります。

• ストリーミングアプリケーションは、ユーザーの購読情報 ​ アクセス権限 ​ を確認し、ユーザーが許可した場合にのみ続行する必要があります。
• ストリーミングアプリケーションは、VSAccountManager に ​ デリゲート ​ を提供する必要があります。
• ストリーミングアプリケーションは、購読者のアカウント情報用に ​ リクエスト ​ を送信する必要があります。
• ストリーミングアプリケーションは、​ メタデータ ​ 情報を待機して処理する必要があります。

• serviceProvider、mvpd、resources など、すべての 必須 パラメーター
• Authorization や AP-Device-Identifier など、すべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。
• 指定した serviceProvider と mvpd の統合はアクティブである必要があります。

• ストリーミングアプリケーションは、ユーザーの購読情報 ​ アクセス権限 ​ を確認し、ユーザーが許可した場合にのみ続行する必要があります。
• ストリーミングアプリケーションは、VSAccountManager に ​ デリゲート ​ を提供する必要があります。
• ストリーミングアプリケーションは、購読者のアカウント情報用に ​ リクエスト ​ を送信する必要があります。
• ストリーミングアプリケーションは、​ メタデータ ​ 情報を待機して処理する必要があります。

• serviceProvider、mvpd、resources など、すべての 必須 パラメーター
• Authorization や AP-Device-Identifier など、すべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。
• 指定した serviceProvider と mvpd の統合はアクティブである必要があります。

• serviceProvider、mvpd、redirectUrl など、すべての 必須 パラメーター
• Authorization、AP-Device-Identifier などのすべての 必須 ヘッダー
• すべての オプション パラメーターおよびヘッダー

• required パラメーターおよびヘッダーは有効である必要があります。
• 指定した serviceProvider と mvpd の統合はアクティブである必要があります。