PayloadKit

Extensible Single Sign-On

com.apple.extensiblesso

The payload that configures an app extension that performs single sign-on (SSO).

iOS 13.0+macOS 10.15+visionOS 1.1+
Apple schemacombined

Configuration Keys (12)

Showing 12 of 12 keys

KeyTypeDescriptionDefaultRange

Extension Identifier

required
stringThe bundle identifier of the app extension that performs SSO for the specified URLs.Default: —Range: com.apple.AppSSOKerberos.KerberosExtension, com.microsoft.azureauthenticator.ssoextension, com.microsoft.CompanyPortalMac.ssoextension
Typestring
required
stringThe type of SSO.Default: —Range: Credential, Redirect

Team Identifier

not on iOS, visionOS

required
stringThe team identifier of the app extension. The device requires this key on macOS and ignores it elsewhere.

Depends on: ExtensionIdentifier ∈ [com.apple.AppSSOKerberos.KerberosExtension];

Default: —Range: apple
Hostsarray
arrayAn array of host or domain names that apps can authenticate through the app extension. Required for 'Credential' payloads. Ignored for 'Redirect' payloads. The system: Matches host or domain names case-insensitively Requires that all the host and domain names of all installed Extensible SSO payloads are unique Note: Host names that begin with a "." are wildcard suffixes that match all subdomains; otherwise the host name needs be an exact match.

Depends on: Type ∈ [Credential]

Default: —Range: —
hostnamestring

Hostname / Domain name

required
stringA host or domain name, with or without a leading dot.Default: —Range: —
Realmstring
required
stringThe realm name for 'Credential' payloads. Use proper capitalization for this value. Ignored for 'Redirect' payloads.

Depends on: ExtensionIdentifier ∈ [com.apple.AppSSOKerberos.KerberosExtension]

Default: —Range: —
URLsarray

URLs

arrayAn array of URL prefixes of identity providers where the app extension performs SSO. Required for 'Redirect' payloads. Ignored for 'Credential' payloads. The URLs need to begin with 'http://' or 'https://'. The system: Matches scheme and host name case-insensitively Doesn't allow query parameters and URL fragments Requires that the URLs of all installed Extensible SSO payloads are unique

Depends on: Type ∈ [Redirect]

Default: —Range: —
URLstring

URL

required
stringAn http or https URL prefix.Default: —Range: —

Denied Bundle Identifiers

iOS 15.0+ · macOS 12.0+

arrayAn array of bundle identifiers of apps that don't use SSO provided by this extension.Default: —Range: —

Bundle Identifier

required
stringThe bundle identifier of the app.Default: —Range: —

Screen Locked Behavior

iOS 15.0+ · macOS 12.0+

stringIf set to 'Cancel', the system cancels authentication requests when the screen is locked. If set to 'DoNotHandle', the request continues without SSO instead. This doesn't apply to requests where 'userInterfaceEnabled' is 'false', or for background 'URLSession' requests.Default: "Cancel"Range: Cancel (Cancel), Do Not Handle (DoNotHandle)

Kerberos Extension Data

dictA dictionary of arbitrary data passed through to the app extension.

Depends on: ExtensionIdentifier ∈ [com.apple.AppSSOKerberos.KerberosExtension]

Default: —Range: —

Allow Automatic Login

booleanIf 'false', the system doesn't allow saving passwords in the keychain.Default: trueRange: —

Allow Password Change

not on iOS, visionOS

booleanIf 'false', the system disables password changes.Default: trueRange: —

Use Platform SSO TGT

macOS 13.0+ · not on iOS, visionOS

booleanIf 'true', the system requires this configuration uses a TGT from Platform SSO instead of requesting a new one.Default: falseRange: —

Allow Platform SSO Authentication Fallback

macOS 13.0+ · not on iOS, visionOS

booleanIf 'true' and 'usePlatformSSOTGT' is 'true', the system allows the user to manually sign in.Default: trueRange: —

Perform Kerberos Requests Only

iOS 16.0+ · macOS 13.0+

booleanIf 'true', the Kerberos Extension handles Kerberos requests only. It doesn't check for password expiration, show the password expiration in the menu, check for external password changes, perform password sync, or retrieve the home directory.Default: falseRange: —
cacheNamestring

Cache Name

iOS · deprecated 15.0 · macOS · deprecated 12.0

deprecated
stringThe GSS name of the Kerberos cache to use. Rarely set by an administrator.Default: —Range: —

Certificate UUID

stringThe PayloadUUID of a PKINIT certificate.Default: —Range: —

Credential Bundle ID ACL

arrayA list of bundle IDs allowed to access the ticket-granting ticket (TGT).Default: —Range: —
stringBundle IDs allowed to access the TGT. These values are case sensitive.Default: —Range: —

Credential Use Mode

iOS 14.0+ · macOS 11.0+

stringThis setting affects how other processes use the Kerberos Extension credential. Allowed values: 'always': The system always uses the credential if the SPN matches the Kerberos Extension 'Hosts' array and the caller hasn't specified another credential. However, the system won't use the credential if the calling app isn't in the 'credentialBundleIDACL'. 'whenNotSpecified': The system only uses the extension credential if the SPN matches the Kerberos Extension 'Hosts' array. However, the system won't use the credential if the calling app isn't in the 'credentialBundleIDACL'. 'kerberosDefault': The system uses the default Kerberos processes to select credentials, and normally uses the default Kerberos credential. This is the same as turning off this capability.Default: "always"Range: Always (always), When Not Specified (whenNotSpecified), Kerberos Default (kerberosDefault)

Custom Username Label

iOS 14.0+ · macOS 11.0+

stringThe custom user name label used in the Kerberos extension instead of "Username," such as "Company ID".Default: —Range: —

Delay User Setup

macOS 11.0+ · not on iOS, visionOS

booleanIf 'true', the system doesn't prompt the user to setup the Kerberos extension until either the administrator enables it with the 'app-sso' tool or the system receives a Kerberos challenge.Default: falseRange: —
helpTextstring

Help Text

iOS 14.0+ · macOS 11.0+

stringThe text to display to the user at the bottom of the Kerberos Login Window. You can also use this to display help information or disclaimer text.Default: —Range: —

Is Default Realm

booleanSpecifies whether this is the default realm if there's more than one Kerberos extension configuration.Default: falseRange: —

Include Managed Apps in Bundle ID ACL

iOS 14.0+ · macOS 12.0+

booleanIf 'true', the Kerberos extension allows only managed apps to access and use the credential. This is in addition to the 'credentialBundleIDACL', if you specify that value.Default: falseRange: —

Include Kerberos Apps in Bundle ID ACL

macOS 12.0+ · not on iOS, visionOS

booleanIf 'true', the Kerberos extension allows the standard Kerberos utilities including 'TicketViewer' and 'klist' to access and use the credential. This is in addition to 'includeManagedAppsInBundleIdACL' or the 'credentialBundleIdACL', if you specify those values.Default: falseRange: —

Monitor Credential Cache

macOS 11.0+ · not on iOS, visionOS

booleanIf 'false', the system requests the credential on the next matching Kerberos challenge or network state change. If the credential is expired or missing, the system creates a new one.Default: trueRange: —

Principal Name

stringThe principal (username) to use. You don't need to include the realm.Default: —Range: —

Preferred KDCs

iOS 15.0+ · macOS 12.0+

arrayThe ordered list of preferred Key Distribution Centers (KDCs) to use for Kerberos traffic. Use this if the servers aren't discoverable through DNS. If you specify the servers, the system uses them for both connectivity checks and attempts to use them first for Kerberos traffic. If the servers don't respond, the device falls back to DNS discovery. Format each entry the same as it would be in a 'krb5.conf' file, for example: 'adserver1.example.com' 'tcp/adserver1.example.com:88' 'kkdcp://kerberosproxy.example.com:443/kkdcp'Default: —Range: —

Key Distribution Center

required
stringA host or domain name in the format of [protocol/]hostname[:port][/path]Default: —Range: —

Password Change URL

not on iOS, visionOS

stringThis URL will launch in the user's default web browser when they initiate a password change.Default: —Range: —

Password Notification Days

not on iOS, visionOS

integerThe number of days prior to password expiration when the system sends a notification of password expiration to the user.Default: 15Range: —

Password Expiration Override

macOS · deprecated 12.0 · not on iOS, visionOS

deprecated
integerThe number of days that the system allows using passwords on this domain. For most domains, this calculation is automatic.Default: —Range: —

Password Requirement Complexity

not on iOS, visionOS

booleanIf 'true', the system requires passwords to meet Active Directory's definition of "complex".Default: falseRange: —

Password Requirement History

not on iOS, visionOS

integerThe number of prior passwords that the system disallows reuse on this domain.Default: —Range: —

Password Requirement Length

not on iOS, visionOS

integerThe minimum length of passwords on the domain.Default: —Range: —

Password Requirement Minimum Age

not on iOS, visionOS

integerThe minimum age of passwords before the system allows changing them on this domain.Default: —Range: —
pwReqTextstring

Password Requirement Text

not on iOS, visionOS

stringThe text version of the domain's password requirements. Only for use if 'pwReqComplexity' or 'pwReqLength' aren't specified.Default: —Range: —

macOS 15.0+ · not on iOS, visionOS

dataThe RTF file formatted version of the domain's password requirements. Only for use if 'pwReqComplexity' or 'pwReqLength' aren't specified.Default: —Range: —

Replication Time

macOS 11.0+ · deprecated 12.0 · not on iOS, visionOS

deprecated
integerThe time, in seconds, required to replicate changes in the Active Directory domain. The Kerberos extension uses this when checking password age after a change.Default: 900Range: —

Require TLS for LDAP

iOS 14.0+ · macOS 11.0+

booleanRequire that LDAP connections use TLS.Default: falseRange: —

Require User Presence

booleanIf 'true', the system requires the user to provide Touch ID, Face ID or their passcode to access the keychain entry.Default: falseRange: —
siteCodestring

Site Code

stringThe name of the Active Directory site the Kerberos extension should use. Most administrators don't need to modify this value, as the Kerberos extension can normally find the site automatically.Default: —Range: —

Sync Local Password

not on iOS, visionOS

booleanIf 'false', the system disables password sync. Note that this will not work if the user is logged in with a mobile account.Default: falseRange: —

Use Site Auto Discovery

booleanIf 'false', the Kerberos extension doesn't automatically use LDAP and DNS to determine its AD site name.Default: trueRange: —
dictA custom domain-realm mapping for Kerberos. The system uses this when the DNS name of hosts doesn't match the realm name. Most administrators don't need to customize this.Default: —Range: —
Realmarray
arrayThe key should be the name of the realm, and the value is an array of DNS suffixes that map to the realm.Default: —Range: —
RealmItemstring
stringDomains to map to the realmDefault: —Range: —

Enable SSO on All Managed Apps

integer—Default: 0Range: Disable (0), Enable (1)

App Allow List

stringEnable SSO for specific appsDefault: —Range: —

App Prefix Allow List

stringEnable SSO for all apps with a specific bundle ID prefixDefault: —Range: —

App Block List

stringDisable SSO for specific appsDefault: —Range: —

App Cookie SSO Allow List

stringEnable SSO through cookies for a specific applicationDefault: —Range: —

Allow Users to Sign in from Unknown Applications using the Safari Browser

integer—Default: 0Range: Disable (0), Enable (1)

Disable Asking for MFA During Initial Bootstrapping

integer—Default: 0Range: Enable (0), Disable (1)

Disable OAuth2 Application Prompts

integer—Default: 0Range: Enable (0), Disable (1)

Disable OAuth2 Application Prompts and Autologin

integer—Default: 0Range: Enable (0), Disable (1)

macOS 15.0+ · not on iOS, visionOS

stringA string with wildcards that can use used to filter the list of available SmartCards by issuer. e.g "*My CA2*". If there's one remaining, it will be auto-selected. If there more than one remaining, then the list is shorter.Default: —Range: —

macOS 15.0+ · not on iOS, visionOS

booleanIf 'true', allow the user to switch the user interface to SmartCard mode.Default: trueRange: —

macOS 15.0+ · not on iOS, visionOS

booleanIf 'true', allow the user to switch the user interface to Password mode.Default: trueRange: —

macOS 15.0+ · not on iOS, visionOS

booleanIf 'true', the user interface will start in SmartCard mode.Default: falseRange: —

Authentication Method

macOS 13.0+ · deprecated 14.0 · not on iOS, visionOS

deprecated
stringThe Platform SSO authentication method the extension uses. Requires that the SSO Extension also supports the method. Don't use this. Use the 'AuthenticationMethod' key in the 'PlatformSSO' dictionary instead.Default: —Range: Password (Password), User Secure Enclave Key (UserSecureEnclaveKey), SmartCard (SmartCard), OpenID (OpenID)

macOS 14.0+ · not on iOS, visionOS

dictThe dictionary to configure Platform SSO. Requires setting 'Type' to 'Redirect'.Default: —Range: —
stringThe Platform SSO authentication method to use with the extension. Requires that the SSO Extension also support the method. 'OpenID' is available in macOS 27 and later.Default: —Range: Password, UserSecureEnclaveKey, SmartCard, OpenID
booleanIf 'true', the system uses the same signing and encryption keys for all users. Only supported on the device channel.Default: falseRange: —
stringThe display name for the account in notifications and authentication requests.Default: —Range: —
integerThe duration, in seconds, until the system requires a full login instead of a refresh. The default value is 64,800 (18 hours). The minimum value is 3600 (1 hour).Default: 64800Range: 3600 – —
booleanEnables creating users at the Login Window with an 'AuthenticationMethod' of either 'Password' or 'SmartCard'. Requires that 'UseSharedDeviceKeys' is 'true'.Default: falseRange: —
booleanEnables using identity provider accounts at authorization prompts. Requires that 'UseSharedDeviceKeys' is 'true'. The system assigns groups using 'AdministratorGroups', 'AdditionalGroups', or 'AuthorizationGroups'.Default: falseRange: —
dictThe attribute mapping to use when creating users, or for authorization.Default: —Range: —
stringThe claim name to use for the user's account name.Default: —Range: —
FullNamestring
stringThe claim name to use for the user's full name.Default: —Range: —
stringThe permission to apply to newly created accounts at login. Allowed values: 'Standard': The account is a standard user. 'Admin': The system adds the account to the local administrators group. 'Groups': The system assigns groups to the account using 'AdministratorGroups', 'AdditionalGroups', or 'AuthorizationGroups'. 'Temporary': The system uses a temporary session configuration for newly created accounts at login.Default: —Range: Standard, Admin, Groups, Temporary
stringThe permission to apply to an account each time the user authenticates. Allowed values: 'Standard': The account is a standard user. 'Admin': The system adds the account to the local administrators group. 'Groups': The system assigns group to the account using 'AdministratorGroups', 'AdditionalGroups', or 'AuthorizationGroups'.Default: —Range: Standard, Admin, Groups
arrayThe list of groups to use for administrator access. The system requests membership during authentication.Default: —Range: —
Groupstring
stringThe group name.Default: —Range: —
arrayThe list of created groups that don't have administrator access.Default: —Range: —
Groupstring
stringThe group name.Default: —Range: —
dictThe pairing of Authorization Rights to group names. When using this, the system updates the Authorization Right to use the group.Default: —Range: —
{{key}}string
required
string—Default: —Range: —
{{value}}string
required
stringThe key is an access right value, the value is the group to be associated with that access right.Default: —Range: —
ANYstring
stringThe key is an access right value, the value is the group to be associated with that access right.Default: —Range: —

macOS 15.0+

arrayThe policy to apply when using Platform SSO at FileVault unlock on a Mac with Apple silicon. 'AttemptAuthentication': The device attempts Platform SSO authentication before proceeding. If offline, unlock continues if the local account password matches. If online and the credential is incorrect, then the device requires a successful Platform SSO authentication is required, even if taken offline. Only use when 'AuthenticationMethod' is 'Password'. 'RequireAuthentication': The device requires Platform SSO authentication before proceeding. If the device is offline and 'AllowOfflineGracePeriod' is enabled, then the device uses the offline 'OfflineGracePeriod' to determine if the user can proceed or not. If online and the credential is incorrect, then the device requires a valid Platform SSO authentication to proceed, regardless of the 'OfflineGracePeriod'. If the account isn't registered for Platform SSO and 'AllowAuthenticationGracePeriod' is enabled, then the device uses 'AuthenticationGracePeriod' to determine if the user can proceed or not. Only use when 'AuthenticationMethod' is 'Password'. 'AllowOfflineGracePeriod': The device allows the use of the 'OfflineGracePeriod'. If 'AllowOfflineGracePeriod' isn't set, then the device denies offline access. Only use when 'AuthenticationMethod' is 'Password' and 'RequireAuthentication' is enabled, or 'AuthenticationMethod' is 'OpenID'. 'AllowAuthenticationGracePeriod': The device allows the use of the 'AuthenticationGracePeriod' for other local accounts when 'RequireAuthentication' is enabled. The 'AuthenticationGracePeriod' starts when any of the policies are updated. If 'AllowAuthenticationGracePeriod' isn't set, then the device denies unregistered account access. Only use when 'AuthenticationMethod' is 'Password'. 'RequireTouchID': The device requires the use of Touch ID (and not Apple Watch) for FileVault unlock. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'RequireTouchIDOrWatch': The device requires the use of Touch ID or Apple Watch for FileVault unlock. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'AllowOpenIDForTouchIDFallback': The device allows web login as a fallback if Touch ID fails or isn't available. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'.Default: —Range: —
policystring
required
stringThe policy to apply.Default: —Range: AttemptAuthentication, RequireAuthentication, AllowOfflineGracePeriod, AllowAuthenticationGracePeriod, RequireTouchID, RequireTouchIDOrWatch, AllowOpenIDForTouchIDFallback

macOS 15.0+

arrayThe policy to apply when using Platform SSO at the Login Window. 'AttemptAuthentication': The device attempts Platform SSO authentication before proceeding. If offline, login continues if the local account password matches. If online and the credential is incorrect, then the device requires a successful Platform SSO authentication to proceed, even if taken offline. Only use when 'AuthenticationMethod' is 'Password'. 'RequireAuthentication': The device requires Platform SSO authentication before proceeding. If the device is offline and 'AllowOfflineGracePeriod' is enabled, then the device uses the offline 'OfflineGracePeriod' to determine if the user can proceed or not. If online and the credential is incorrect, then the device requires a valid Platform SSO authentication to proceed, regardless of the 'OfflineGracePeriod'. If the account isn't registered for Platform SSO and 'AllowAuthenticationGracePeriod' is enabled, then the device uses the 'AuthenticationGracePeriod' to determine if the user can proceed or not. Only use when 'AuthenticationMethod' is 'Password'. 'AllowOfflineGracePeriod': The device allows the use of the 'OfflineGracePeriod'. If 'AllowOfflineGracePeriod' isn't set, then the device denies offline access. Only use when 'AuthenticationMethod' is 'Password' and 'RequireAuthentication' is enabled, or 'AuthenticationMethod' is 'OpenID'. 'AllowAuthenticationGracePeriod': The device allows the use of the 'AuthenticationGracePeriod' for other local accounts when 'RequireAuthentication' is enabled. The 'AuthenticationGracePeriod' starts when any of the policies have been updated. If 'AllowAuthenticationGracePeriod' isn't set, then the device denies unregistered account access. Only use when 'AuthenticationMethod' is 'Password'. 'RequireTouchID': The device requires the use of Touch ID (and not Apple Watch) for login. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'RequireTouchIDOrWatch': The device requires the use of Touch ID or Apple Watch for login. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'AllowOpenIDForTouchIDFallback': The device allows web login as fallback if Touch ID fails or isn't available. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'.Default: —Range: —
policystring
required
stringThe policy to apply.Default: —Range: AttemptAuthentication, RequireAuthentication, AllowOfflineGracePeriod, AllowAuthenticationGracePeriod, RequireTouchID, RequireTouchIDOrWatch, AllowOpenIDForTouchIDFallback

macOS 15.0+

arrayThe policy to apply when using Platform SSO at screensaver unlock. 'AttemptAuthentication': The device attempts Platform SSO authentication before proceeding. If offline, unlock will continue if the local account password matches. If online and the credential is incorrect, then the device requires a successful Platform SSO authentication to proceed, even if taken offline. Only use when 'AuthenticationMethod' is 'Password'. 'RequireAuthentication': The device requires Platform SSO authentication before proceeding. If the device is offline and 'AllowOfflineGracePeriod' is enabled, then the offline 'OfflineGracePeriod' is used to determine if the user can proceed or not. If online and the credential is incorrect, then the device requires a valid Platform SSO authentication to proceed regardless of the 'OfflineGracePeriod'. If the account isn't registered for Platform SSO and 'AllowAuthenticationGracePeriod' is enabled, then the device uses 'AuthenticationGracePeriod' to determine if the user can proceed or not. Only use when 'AuthenticationMethod' is 'Password'. 'AllowOfflineGracePeriod': The device allows the use of the 'OfflineGracePeriod'. If 'AllowOfflineGracePeriod' isn't set, then the device denies offline access. Only use when 'AuthenticationMethod' is 'Password' and 'RequireAuthentication' is enabled, or 'AuthenticationMethod' is 'OpenID'. 'AllowAuthenticationGracePeriod': The device allows the use of the 'AuthenticationGracePeriod' for other local accounts when 'RequireAuthentication' is enabled. The 'AuthenticationGracePeriod' starts when any of the policies have been updated. If 'AllowAuthenticationGracePeriod' isn't set, then the device denies the unregistered account access. Only use when 'AuthenticationMethod' is 'Password'. 'AllowTouchIDOrWatchForUnlock': The device allows Touch ID or Apple Watch to unlock the screensaver instead of Platform SSO authentication when 'RequireAuthentication' is enabled. Only use when 'AuthenticationMethod' is 'Password'. 'RequireTouchID': The device requires the use of Touch ID (and not Apple Watch) for unlock. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'RequireTouchIDOrWatch': The device requires the use of Touch ID or Apple Watch for unlock. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'. 'AllowOpenIDForTouchIDFallback': The device allows web login as fallback if Touch ID fails or isn't available. Only use when 'AuthenticationMethod' is 'Password' or 'UserSecureEnclaveKey'.Default: —Range: —
policystring
required
stringThe policy to apply.Default: —Range: AttemptAuthentication, RequireAuthentication, AllowOfflineGracePeriod, AllowAuthenticationGracePeriod, AllowTouchIDOrWatchForUnlock, RequireTouchID, RequireTouchIDOrWatch, AllowOpenIDForTouchIDFallback

macOS 15.0+

integerThe amount of time (in seconds) after the last successful Platform SSO login for using a local account password offline. Required when setting 'AllowOfflineGracePeriod'.Default: —Range: —

macOS 15.0+

integerThe amount of time (in seconds) after receiving or updating a 'FileVaultPolicy', 'LoginPolicy', or 'UnlockPolicy' that the system can use unregistered local accounts. Required when 'AllowAuthenticationGracePeriod' is set.Default: —Range: —

macOS 15.0+

arrayThe list of local accounts that aren't subject to the 'FileVaultPolicy', 'LoginPolicy', or 'UnlockPolicy'. The accounts don't receive a prompt to register for Platform SSO.Default: —Range: —
usernamestring
required
stringA local account username.Default: —Range: —
booleanIf 'true', the system includes the device UDID and serial number in Platform SSO attestations.Default: falseRange: —
booleanIf 'true', the device uses Platform SSO to create the first user account on the Mac during 'Setup Assistant'.Default: trueRange: —
arrayThe set of authentication methods to use for newly created accounts at login or during 'Setup Assistant'. The system uses 'Password' and 'SmartCard' if this key isn't present.Default: —Range: —
stringAn authentication method to use for newly created accounts at login or during 'Setup Assistant'. Allowed values: 'Password': The account uses a password for authentication. 'SmartCard': The account uses a smart card for authentication. 'AccessKey': The account uses an access key for authentication. 'OpenID': The account uses OpenID for authentication. Available in macOS 27 and later.Default: —Range: Password, SmartCard, AccessKey, OpenID
dataThe reader group identifier for use with the 'AccessKey'. The value needs to match the configured access key. Required if 'NewUserAuthenticationMethods' contains 'AccessKey'.Default: —Range: —
stringThe 'PayloadUUID' of an identity payload to use as the 'Terminal' identity of the access key. The identity needs to be trusted by the access key. Required if 'NewUserAuthenticationMethods' includes 'AccessKey'. Allowed identity payload types: 'com.apple.security.pkcs12' 'com.apple.security.acme' 'com.apple.security.scep'Default: —Range: —

Access Key Reader Issuer Certificate UUID

macOS 26.2+

stringThe 'PayloadUUID' of a certificate payload for the issuer certificate of the 'Terminal' identity of the access key. Other specifications refer to the key as the "Reader CA Public Key". The key must be an elliptic curve key. Required if 'NewUserAuthenticationMethods' includes 'AccessKey'. The issuer of the Terminal identity of the access key needs to match this certificate, otherwise the device fails the authentication.Default: —Range: —

macOS 26.0+

booleanIf 'true', the system uses the access key in express mode, and doesn't require authentication before use.Default: falseRange: —

macOS 26.0+

booleanIf 'true', the system requests the user's profile picture from the SSO extension.Default: falseRange: —

macOS 26.0+

booleanIf 'true', the system uses a quicker Authenticated Guest Mode login to Mac behavior. The system erases user data from only select locations in the user home directory after each session completes. Once every eight hours the system erases the full user home directory after a session completes. Turn this on for shared environments that have a high frequency of short sessions.Default: falseRange: —
booleanIf 'true', the system enables the PlatformSSO registration process during Setup Assistant on devices running macOS 26 and later. Set this key to 'true' when configuring PlatformSSO before enrollment using the 'com.apple.psso.required' error response.Default: falseRange: —

macOS 27.0+

arrayThe set of allowed hosts that the system can load in the PSSO web view. Required if 'AuthenticationMethod' is 'OpenID', or 'NewUserAuthenticationMethods' contains 'OpenID'.Default: —Range: —
Hostsstring
stringA host or host prefix.Default: —Range: —

macOS 27.0+

booleanIf 'true', the system detects the password during web login and synchronizes it to the local account password for the user.Default: falseRange: —

Registration Token

macOS 13.0+ · not on iOS, visionOS

stringThe token this device uses for registration with Platform SSO. Use it for silent registration with the Identity Provider. Requires that 'AuthenticationMethod' in 'PlatformSSO' isn't empty.Default: —Range: —