Files
apple_device-management/mdm/profiles/com.apple.google-oauth.yaml
T
2026-06-22 15:55:19 -04:00

107 lines
3.2 KiB
YAML

title: Google Account
description: The payload that configures a Google account.
payload:
payloadtype: com.apple.google-oauth
supportedOS:
iOS:
introduced: '9.3'
multiple: true
supervised: false
allowmanualinstall: true
sharedipad:
mode: allowed
devicechannel: false
userchannel: true
userenrollment:
mode: allowed
macOS:
introduced: n/a
tvOS:
introduced: n/a
visionOS:
introduced: '1.1'
multiple: true
supervised: false
allowmanualinstall: true
userenrollment:
mode: allowed
watchOS:
introduced: n/a
content: A Google account payload sets up a Google email address as well as any
other Google services the user enables after authentication. Google accounts must
be installed via MDM or by Apple Configurator 2 (if the device is supervised).
The payload never contains credentials and the user will be prompted to enter
their credentials shortly after the payload successfully installs. On Shared iPad,
this payload can only be installed on the MDM user channel.
payloadkeys:
- key: AccountDescription
title: Account description
type: <string>
presence: optional
content: A user-visible description of the Google account, shown in the Mail and
Settings apps.
- key: AccountName
title: Account name
type: <string>
presence: optional
content: The user's full name for the Google account. This name appears in sent
messages.
- key: EmailAddress
title: Email address
type: <string>
presence: required
content: The full Google email address for the account.
- key: CommunicationServiceRules
title: Communication service rules
supportedOS:
iOS:
introduced: '10.0'
type: <dictionary>
presence: optional
content: The communication service handler rules for this account.
subkeys:
- key: DefaultServiceHandlers
title: Default service handlers
supportedOS:
iOS:
introduced: '10.0'
macOS:
introduced: n/a
type: <dictionary>
presence: optional
content: A dictionary that defines which app to use for audio calls from this
account.
subkeys:
- key: AudioCall
title: App for audio calls
supportedOS:
iOS:
introduced: '10.0'
macOS:
introduced: n/a
type: <string>
presence: optional
content: The bundle identifier for the default application that handles audio
calls to contacts from this account.
- key: VPNUUID
title: VPNUUID
supportedOS:
iOS:
introduced: '14.0'
type: <string>
presence: optional
content: The VPNUUID of the per-app VPN the account uses for network communication.
notes:
- title: ''
content: |-
You can install multiple Google payloads. Each sets up a Google email address and any other Google services the user enables after authentication.
> Note:
> For supervised devices, the system requires installation of Google accounts through MDM or Apple Configurator 2.
The payload never contains credentials; the system prompts the user to enter credentials shortly after installation of the payload.
examples:
- title: Profile example
files:
- file: examples/mdm/profiles/com.apple.google-oauth/example1.plist