Files
apple_device-management/declarative/declarations/assets/credential.certificate.yaml
T
2026-08-18 15:34:21 -04:00

82 lines
3.0 KiB
YAML

title: Asset:Credential Certificate
description: 'A reference to one PKCS #1 or PEM encoded certificate.'
payload:
declarationtype: com.apple.asset.credential.certificate
supportedOS:
iOS:
introduced: '17.0'
macOS:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:
- key: Reference
title: External reference
type: <dictionary>
asset-content-types:
- application/pkcs1
- application/pem
presence: required
content: The external reference. Ensure the asset data contains exactly one certificate.
If the PEM data contains more than one certificate, the system installs the first
certificate and ignores the rest. Ensure that the asset data uses a media type
of `application/pkcs1` or `application/pem` to correctly identify the type of
encoded certificate. If the asset data includes a `ContentType` sub-key, set it
to the corresponding media type.
subkeys:
- key: DataURL
title: Data URL
type: <string>
presence: required
content: The URL to retrieve data, which needs to start with `https://`.
- key: ContentType
title: Content type
type: <string>
presence: optional
content: The media type that describes the data. If present, the system checks
the actual media type of the downloaded data, and an error occurs if the values
don't match.
- key: Size
title: Size
type: <integer>
presence: optional
content: The size of the data. Set the size to `0` if there's no expectation of
a response body. If present, the system checks the actual size of the downloaded
data, and an error occurs if the values don't match.
- key: Hash-SHA-256
title: SHA-256 hash
type: <string>
presence: optional
content: A SHA-256 hash of the data stored at the `DataURL`. Don't set this value
if `Size` is `0` as the client ignores it. However, if present, the system checks
the actual hash of the downloaded data, and an error occurs if the values don't
match.
- key: Authentication
title: Server authentication
type: <dictionary>
presence: optional
content: The server authentication details. If this key is absent, the default authentication
type is MDM.
subkeys:
- key: Type
title: Authentication type
type: <string>
presence: required
rangelist:
- MDM
- None
content: |-
The type of authentication, which has these allowed values:
- `MDM`: A request that uses MDM semantics, which includes the device-identity certificate, and any user authentication. This is equivalent to an MDM request made to the `CheckInURL` or `ServerURL`. This option is only available through declarative device management.
- `None`: A standard GET request.
If the `Authentication` dictionary is absent, the default authentication type is MDM.
examples:
- title: Asset example
files:
- file: examples/declarative/declarations/assets/credential.certificate/example1.json