Files
apple_device-management/declarative/declarations/assets/credential.scep.yaml
T
2025-09-15 20:38:03 -04:00

78 lines
2.8 KiB
YAML

title: Asset:Credential SCEP
description: A reference to a SCEP identity.
payload:
declarationtype: com.apple.asset.credential.scep
supportedOS:
iOS:
introduced: '17.0'
macOS:
introduced: '14.0'
tvOS:
introduced: '17.0'
visionOS:
introduced: '1.1'
watchOS:
introduced: '10.0'
payloadkeys:
- key: Reference
type: <dictionary>
asset-content-types:
- application/json
presence: required
content: |-
The external reference. Ensure that the asset data:
- Is a JSON document that represents the `com.apple.credential.scep` credential type
- Uses a media type of `application/json`, and if it includes a `ContentType` sub-key, that sub-key media type is also `application/json`
subkeys:
- key: DataURL
type: <string>
presence: required
content: The URL to retrieve data, which needs to start with `https://`.
- key: ContentType
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
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
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
type: <dictionary>
presence: optional
content: The server authentication details.
subkeys:
- key: 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.
- key: Accessible
type: <string>
presence: optional
rangelist:
- Default
- AfterFirstUnlock
default: Default
content: |-
The keychain accessibility that determines when the keychain item is available for use, which has these allowed values:
- `Default`: The most restrictive accessibility that still satisfies all uses of the asset by configurations that reference it.
- `AfterFirstUnlock`: The keychain item is only available after the first unlock of the device.