Contents

ExtensibleSingleSignOn.PlatformSSO

The dictionary to configure Platform SSO. Requires Type to be set to Redirect.

Declaration

object ExtensibleSingleSignOn.PlatformSSO

Properties

NameTypeDescription
AccessKeyReaderGroupIdentifierdata

The reader group identifier for use with the AccessKey. The value needs to match the configured access key. Required if NewUserAuthenticationMethods contains AccessKey.

AccessKeyReaderIssuerCertificateUUIDstring

The 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.

AccessKeyTerminalIdentityUUIDstring

The 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

AccountDisplayNamestring

The display name for the account in notifications and authentication requests.

AdditionalGroups[string]

The list of created groups that don’t have administrator access.

AdministratorGroups[string]

The list of groups to use for administrator access. The system requests membership during authentication.

AllowAccessKeyExpressModeboolean

If true, the system uses the access key in express mode, and doesn’t require authentication before use.

AllowDeviceIdentifiersInAttestationboolean

If true, the system includes the device UDID and serial number in Platform SSO attestations.

AuthenticationGracePeriodinteger

The amount of time after receiving or updating a FileVaultPolicy, LoginPolicy, or UnlockPolicy that the system can use unregistered local accounts. Required when AllowAuthenticationGracePeriod is set. Available in macOS 15 and later.

AuthenticationMethodstring

The Platform SSO authentication method to use with the extension. Requires that the SSO Extension also support the method.

AuthorizationGroupsExtensibleSingleSignOn.PlatformSSO.AuthorizationGroups

The pairing of Authorization Rights to group names. When using this, the system updates the Authorization Right to use the group.

EnableAuthorizationboolean

Enables using identity provider accounts at authorization prompts. Requires that UseSharedDeviceKeys is true. The system assigns groups using AdministratorGroups, AdditionalGroups, or AuthorizationGroups.

EnableCreateFirstUserDuringSetupboolean

If true, the device uses Platform SSO to create the first user account on the Mac during Setup Assistant.

EnableCreateUserAtLoginboolean

Enables creating users at the Login Window with an AuthenticationMethod of either Password or SmartCard. Requires that UseSharedDeviceKeys is true.

EnableRegistrationDuringSetupboolean

If 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.

FileVaultPolicy[string]

The policy to apply when using Platform SSO at FileVault unlock on a Mac with Apple silicon. Applies when AuthenticationMethod is Password. Available in macOS 15 and later.

LoginFrequencyinteger

The 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).

LoginPolicy[string]

The policy to apply when using Platform SSO at the Login Window. Applies when AuthenticationMethod is Password. Available in macOS 15 and later.

NewUserAuthenticationMethods[string]

The 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.

NewUserAuthorizationModestring

The 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.

NonPlatformSSOAccounts[string]

The 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. Available in macOS 15 and later.

OfflineGracePeriodinteger

The amount of time after the last successful Platform SSO login for using a local account password offline. Required when setting AllowOfflineGracePeriod. Available in macOS 15 and later.

SynchronizeProfilePictureboolean

If true, the system requests the user’s profile picture from the SSO extension.

TemporarySessionQuickLoginboolean

If 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.

TokenToUserMappingExtensibleSingleSignOn.PlatformSSO.TokenToUserMapping

The attribute mapping to use when creating users, or for authorization.

UnlockPolicy[string]

The policy to apply when using Platform SSO at screensaver unlock. Applies when AuthenticationMethod is Password. Available in macOS 15 and later.

UserAuthorizationModestring

The 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.

UseSharedDeviceKeysboolean

If true, the system uses the same signing and encryption keys for all users. Only supported on the device channel.

Mentioned in

Topics

Objects

See Also

Objects