PayloadKit

SCEP

com.apple.security.scep

The payload that configures Simple Certificate Enrollment Protocol (SCEP) settings.

iOS 4.0+macOS 10.7+tvOS 9.0+watchOS 3.0+visionOS 1.0+
Apple schemacombined

Configuration Keys (1)

KeyTypeDescriptionDefaultRange

Payload content

required
dictA dictionary containing the SCEP information.Default: —Range: —
URLstring

URL

macOS 10.7+

required
stringThe SCEP URL. See Over-the-Air Profile Delivery and Configuration for more information about SCEP.Default: —Range: —
Namestring

Name

stringA string that's understood by the SCEP server; for example, a domain name like example.org. If a certificate authority has multiple CA certificates, use this field to distinguish which is required.Default: —Range: —
Subjectarray

Subject

arrayThe representation of an X.500 name as an array of OID and value. For example, '/C=US/O=Apple Inc./CN=foo/1.2.5.3=bar' translates to '[ [ ["C", "US"] ], [ ["O", "Apple Inc."] ], …, [ [ "1.2.5.3", "bar" ] ] ]'. You can represent OIDs as dotted numbers, with shortcuts for country (C), locality (L), state (ST), organization (O), organizational unit (OU), and common name (CN).Default: —Range: —

Array inside SCEP subject array

arrayThis array holds another array which holds an OID value pairDefault: —Range: —

Subject array pair

arrayAn array representing an OID and value pair.Default: —Range: —

SCEP subject array pair item

stringOne item in the array representing a pair of OID and valueDefault: —Range: —
Challengestring

Challenge

stringA preshared secret.Default: —Range: —
Keysizeinteger

Key size

integerThe key size, in bits.Default: 1024Range: 1024, 2048, 4096

Fingerprint

dataThe fingerprint of the Certificate Authority certificate.Default: —Range: —
Key Typestring

Key type

stringAlways 'RSA'.Default: "RSA"Range: RSA
Key Usageinteger

Key usage

macOS 10.11+

integerA bitmask indicating the use of the key. Possible values: '1': Signing '4': Encryption Some certificate authorities, such as Windows CA, support only encryption or signing, but not both at the same time.Default: 0Range: None (0), Signing (1), Encryption (4), Both signing and encryption (5)

Key is Extractable

macOS 10.13.4+

booleanIf 'false', the system disables exporting the private key from the keychain.Default: trueRange: —

Subject alt name

dictThe SCEP payload can specify an optional 'SubjectAltName' dictionary that provides values required by the CA for issuing a certificate. You can specify a single string or an array of strings for each key. The values you specify depend on the CA you're using, but might include DNS name, URL, or email values. For an example, see Sample Configuration Profile or Over-the-Air Profile Delivery and Configuration.Default: —Range: —

RFC 822 name

stringThe RFC 822 (email address) string.Default: —Range: —
dNSNamestring

DNS name

stringThe DNS name.Default: —Range: —
stringThe Uniform Resource Identifier.Default: —Range: —

NT principal name

stringThe NT principal name. Use an other name OID set to '1.3.6.1.4.1.311.20.2.3'.Default: —Range: —
Retriesinteger

Retries

macOS 10.10+

integerThe number of times the device should retry if the server sends a PENDING response.Default: 3Range: —
RetryDelayinteger

Retry delay

macOS 10.10+

integerThe number of seconds to wait between subsequent retries. The device attempts the first retry without this delay.Default: 10Range: —

Certificate Expiration Notification

integerThe number of days before the certificate expires at which to start showing the expiration notificationDefault: 14Range: —

Allow all apps access

macOS 10.10+

booleanIf 'true', all apps have access to the private key.Default: falseRange: —