Property List

Entitlements

Key-value pairs that grant an executable permission to use a service or technology.

Discussion

An entitlement is a right or privilege that grants an executable particular capabilities. For example, an app needs the HomeKit Entitlement — along with explicit user consent — to access a user’s home automation network. An app stores its entitlements as key-value pairs embedded in the code signature of its binary executable.

You configure entitlements for your app by declaring capabilities for a target in Xcode. Xcode records capabilities that you add in a property list file with the .entitlements extension. You can also edit the entitlements file directly. When code signing your app, Xcode combines the entitlements file, information from your developer account, and other project information to apply a final set of entitlements to your app.

Topics

Authentication

AutoFill Credential Provider Entitlement

A Boolean value that indicates whether the app may, with user permission, provide user names and passwords for AutoFill in Safari and other apps.

Key: com.apple.developer.authentication-services.autofill-credential-provider
Sign in with Apple Entitlement

An entitlement that lets your app use Sign in with Apple.

Key: com.apple.developer.applesignin

Contacts

com.apple.developer.contacts.notes

A Boolean value that indicates whether the app may access the notes stored in contacts.

Education

ClassKit Environment Entitlement

The ClassKit development or production environment for an education app that works with the Schoolwork app.

Key: com.apple.developer.ClassKit-environment

Games

Game Center Entitlement

A Boolean value that indicates whether users of the app may see and compare achievements on a leaderboard, invite friends, and start multiplayer games.

Key: com.apple.developer.game-center

Health

HealthKit Entitlement

A Boolean value that indicates whether the app may request user authorization to access health and activity data that appears in the Health app.

Key: com.apple.developer.healthkit
HealthKit Capabilities Entitlement

Health data types that require additional permission.

Key: com.apple.developer.healthkit.access

Home Automation

HomeKit Entitlement

A Boolean value that indicates whether users of the app may manage HomeKit-compatible accessories.

Key: com.apple.developer.homekit

iCloud

com.apple.developer.icloud-container-development-container-identifiers

The container identifiers for the iCloud development environment.

com.apple.developer.icloud-container-environment

The development or production environment to use for the iCloud containers.

iCloud Container Identifiers Entitlement

The container identifiers for the iCloud production environment.

Key: com.apple.developer.icloud-container-identifiers
iCloud Services Entitlement

The iCloud services used by the app.

Key: com.apple.developer.icloud-services
iCloud Key-Value Store Entitlement

The container identifier to use for iCloud key-value storage.

Key: com.apple.developer.ubiquity-kvstore-identifier

Media

Inter-App Audio Entitlement

A Boolean value that indicates whether the app may exchange audio with other Inter-App Audio-enabled apps.

Key: inter-app-audio

Networking

Network Extensions Entitlement

The APIs an app can use to customize networking features.

Key: com.apple.developer.networking.networkextension
Personal VPN Entitlement

The API an app can use to create and control a custom system VPN configuration.

Key: com.apple.developer.networking.vpn.api
Associated Domains Entitlement

The associated domains for specific services, such as shared web credentials and universal links.

Key: com.apple.developer.associated-domains

Push Notifications

APS Environment Entitlement

The environment for push notifications.

Key: aps-environment
APS Environment (macOS) Entitlement

The environment for push notifications in macOS apps.

Key: com.apple.developer.aps-environment

Security

App Sandbox

Restrict access to system resources and user data in macOS apps to contain damage if an app becomes compromised.

Hardened Runtime

Manage security protections and resource access for your macOS apps.

App Groups Entitlement

A list of identifiers specifying the groups your app belongs to.

Key: com.apple.security.application-groups
Keychain Access Groups Entitlement

The identifiers for the keychain groups that the app may share items with.

Key: keychain-access-groups
Data Protection Entitlement

The level of data protection that encrypts sensitive user data when accessed on some devices.

Key: com.apple.developer.default-data-protection

Siri

Siri Entitlement

A Boolean value that indicates whether the app handles Siri requests.

Key: com.apple.developer.siri

System

System Extensions

Extend the capabilities of macOS from user space.

TV

com.apple.developer.user-management

An entitlement that lets you access user accounts on Apple TV.

Wallet

Pass Type IDs Entitlement

A list of identifiers that specify pass types that your app can access in Wallet.

Key: com.apple.developer.pass-type-identifiers
Merchant IDs Entitlement

A list of merchant IDs your app uses for Apple Pay support.

Key: com.apple.developer.in-app-payments

Wireless Interfaces

Access WiFi Information Entitlement

A Boolean value indicating whether your app can access information about the connected Wi-Fi network.

Key: com.apple.developer.networking.wifi-info
Wireless Accessory Configuration Entitlement

A Boolean value indicating whether your app may configure MFi Wi-Fi accessories.

Key: com.apple.external-accessory.wireless-configuration
Multipath Entitlement

A Boolean value indicating whether your app may use Multipath protocols to seamlessly transition between Wi-Fi and cellular networks.

Key: com.apple.developer.networking.multipath
Hotspot Configuration Entitlement

A Boolean value indicating whether your app can use the hotspot manager to configure Wi-Fi networks.

Key: com.apple.developer.networking.HotspotConfiguration
Near Field Communication Tag Reader Session Formats Entitlement

The Near Field Communication data formats an app can read.

Key: com.apple.developer.nfc.readersession.formats

Deprecated Entitlements

Maps Entitlement

A Boolean value that indicates whether the app may provide directions beyond what Maps supports, such as subway routes, hiking trails, and bike paths.

Key: com.apple.developer.maps
Deprecated