<!--
{
  "availability" : [
    "iOS: 10.0.0 -",
    "iPadOS: 10.0.0 -",
    "macOS: -",
    "tvOS: 10.0.0 -",
    "visionOS: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "VideoSubscriberAccount",
  "identifier" : "/documentation/VideoSubscriberAccount/VSAccountMetadataRequest",
  "metadataVersion" : "0.1.0",
  "role" : "Class",
  "symbol" : {
    "kind" : "Class",
    "modules" : [
      "Video Subscriber Account"
    ],
    "preciseIdentifier" : "c:objc(cs)VSAccountMetadataRequest"
  },
  "title" : "VSAccountMetadataRequest"
}
-->

# VSAccountMetadataRequest

An object that specifies what subscriber account information your app retrieves.

```
class VSAccountMetadataRequest
```

## Overview

Use a `VSAccountMetadataRequest` object to indicate the specific information your app will obtain about a subscriber from their subscription provider. Also, use this object to provide information to the subscription provider that it needs to perform the request, such as a verification token, the authentication schemes your app supports, or your app’s identifier.

## Topics

### Requesting TV Provider Info

[`includeAccountProviderIdentifier`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/includeAccountProviderIdentifier)

A Boolean value that indicates whether your app requests the identifier of the account provider.

[`includeAuthenticationExpirationDate`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/includeAuthenticationExpirationDate)

A Boolean value that indicates whether your app requests the expiration date of the user’s current authentication session.

### Requesting App-Level Authentication

[`attributeNames`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/attributeNames)

The SAML attributes that your app sends to the account provider.

[`channelIdentifier`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/channelIdentifier)

The channel identifier for the request.

[`supportedAccountProviderIdentifiers`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/supportedAccountProviderIdentifiers)

A list of identifiers for TV providers that your app supports.

[`supportedAuthenticationSchemes`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/supportedAuthenticationSchemes)

A collection of authentication schemes your app supports for this request.

[`verificationToken`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/verificationToken)

A token that your app sends to an account provider to identify itself.

### Specifying Additional Options

[`isInterruptionAllowed`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/isInterruptionAllowed)

A Boolean value that indicates whether your app can prompt the user to authenticate to complete the request.

[`featuredAccountProviderIdentifiers`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/featuredAccountProviderIdentifiers)

The providers your app lists prominently during authentication.

[`forceAuthentication`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/forceAuthentication)

A Boolean value that indicates whether the app ignores cached credentials.

[`localizedVideoTitle`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/localizedVideoTitle)

A short, user-presentable name for the video that the user wants to play.

[`applicationAccountProviders`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/applicationAccountProviders)

An array of application-specific providers to add to the list of account providers.

### Supporting Authentication Share

[`accountProviderAuthenticationToken`](/documentation/VideoSubscriberAccount/VSAccountMetadataRequest/accountProviderAuthenticationToken)

An authentication session token that your app sends to the account provider.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)