Apple Business API
Automate device management activities, view device information, and manage users and user groups in Apple Business.
Overview
Topics
Authentication
Devices
Get Organization DevicesGet Device InformationGet AppleCare coverage Information for a DeviceGet Devices Enrolled in Apple Device Management ServiceGet Details for a Device Enrolled in Apple Device Management Service
Device Management Services
Get Device Management ServicesGet Device Management Service InformationCreate a Device Management ServiceUpdate a Device Management ServiceDelete a Device Management ServiceGet the Device Serial Numbers for a Device Management ServiceGet the Assigned Device Management Service ID for a DeviceGet the Assigned Device Management Service Information for a DeviceAssign or Unassign Devices to a Device Management Service or Release DevicesGet Organization Device Activity Information
Users
UserGroups
Organizational Units
Apps and Packages
Blueprints
Get BlueprintsCreate a BlueprintGet Blueprint InformationUpdate a BlueprintDelete a BlueprintGet App IDs for a BlueprintAdd Apps to a BlueprintRemove Apps from a BlueprintGet Configuration IDs for a BlueprintAdd Configurations to a BlueprintRemove Configurations from a BlueprintGet Package IDs for a BlueprintAdd Packages to a BlueprintRemove Packages from a BlueprintGet Device IDs for a BlueprintAdd Devices to a BlueprintRemove Devices from a BlueprintGet User IDs for a BlueprintAdd Users to a BlueprintRemove Users from a BlueprintGet User Group IDs for a BlueprintAdd User Groups to a BlueprintRemove User Groups from a Blueprint
Configurations
Get ConfigurationsCreate a ConfigurationGet Configuration InformationUpdate a ConfigurationDelete a Configuration
Audit Events
Objects and Data Types
OrgDeviceOrgDeviceResponseOrgDevicesResponseOrgDeviceAssignedServerLinkageResponseMdmDeviceMdmDeviceResponseMdmDevicesResponseMdmDeviceDetailMdmDeviceDetailResponseMdmServerMdmServerResponseMdmServersResponseMdmServerDevicesLinkagesResponseOrgDeviceActivityOrgDeviceActivityCreateRequestOrgDeviceActivityResponseAppleCareCoverageAppleCareCoverageResponseUserUserResponseUsersResponseUserPhoneNumberUserRoleOuMappingUserGroupUserGroupResponseUserGroupsResponseUserGroupUsersLinkagesResponseOrganizationalUnitOrganizationalUnitResponseOrganizationalUnitsResponseOrganizationalUnitUsersLinkagesResponseAppAppResponseAppsResponsePackagePackageResponsePackagesResponseBlueprintBlueprintResponseBlueprintsResponseBlueprintCreateRequestBlueprintUpdateRequestBlueprintAppsLinkagesRequestBlueprintAppsLinkagesResponseBlueprintConfigurationsLinkagesRequestBlueprintConfigurationsLinkagesResponseBlueprintPackagesLinkagesRequestBlueprintPackagesLinkagesResponseBlueprintOrgDevicesLinkagesRequestBlueprintOrgDevicesLinkagesResponseBlueprintUsersLinkagesRequestBlueprintUsersLinkagesResponseBlueprintUserGroupsLinkagesRequestBlueprintUserGroupsLinkagesResponseConfigurationConfigurationResponseConfigurationsResponseConfigurationCreateRequestConfigurationUpdateRequestConfigurationCommonConfigurationCustomSettingCustomSettingsValuesPagedDocumentLinksPagingInformationRelationshipLinksResourceLinksErrorResponseErrorLinksJsonPointerParameterDocumentLinks
Type Aliases
OrgDeviceActivityTypeAppleCareCoveragePaymentTypeAppleCareCoverageStatusUserStatusUserPhoneNumberTypeUserGroupStatusUserGroupTypeSupportedOSBlueprintStatusConfigurationTypeConfigurationPlatformActivationLockTypeAuditEventActorTypeAuditEventCategoryAuditEventOutcomeAuditEventPurchaseSourceTypeAuditEventReleaseEntityTypeAuditEventSubjectTypeAuditEventTypeDeviceEraseStatusDeviceLockStatusLostModeStatusMdmMigrationStatus
Endpoints
Dictionaries
ActivationLockStatusActivityTypeMetadataAuditEventAuditEventAccountAddedAuditEventAccountAddedAttributesAuditEventAccountDeletedAuditEventAccountDeletedAttributesAuditEventAccountRoleLocationAuditEventAccountRoleLocationChangedAuditEventAccountRoleLocationChangedAttributesAuditEventApiAccountCreatedWithKeyAuditEventApiAccountCreatedWithKeyAttributesAuditEventApiAccountCreatedWithoutKeyAuditEventApiAccountCreatedWithoutKeyAttributesAuditEventApiAccountDeletedAuditEventApiAccountDeletedAttributesAuditEventApiAccountKeyGeneratedAuditEventApiAccountKeyGeneratedAttributesAuditEventApiAccountKeyRevokedAuditEventApiAccountKeyRevokedAttributesAuditEventApiAccountNameChangedAuditEventApiAccountNameChangedAttributesAuditEventApiAccountRoleLocationChangedAuditEventApiAccountRoleLocationChangedAttributesAuditEventCollectionCreatedAuditEventCollectionCreatedAttributesAuditEventCollectionDeletedAuditEventCollectionDeletedAttributesAuditEventCollectionUpdatedAuditEventCollectionUpdatedAttributesAuditEventCommonAttributesAuditEventConfigSettingsCreatedAuditEventConfigSettingsCreatedAttributesAuditEventConfigSettingsDeletedAuditEventConfigSettingsDeletedAttributesAuditEventConfigSettingsUpdatedAuditEventConfigSettingsUpdatedAttributesAuditEventDeviceAddedToOrgAuditEventDeviceAddedToOrgAttributesAuditEventDeviceAssignedToServerAuditEventDeviceAssignedToServerAttributesAuditEventDeviceIsErasedAuditEventDeviceIsErasedAttributesAuditEventDeviceRemovedFromOrgAuditEventDeviceRemovedFromOrgAttributesAuditEventDeviceUnassignedFromServerAuditEventDeviceUnassignedFromServerAttributesAuditEventDomainAddedAuditEventDomainAddedAttributesAuditEventDomainRemovedAuditEventDomainRemovedAttributesAuditEventDomainVerifiedAuditEventDomainVerifiedAttributesAuditEventExternalAccountAssociatedAuditEventExternalAccountAssociatedAttributesAuditEventExternalAccountDisassociatedAuditEventExternalAccountDisassociatedAttributesAuditEventSubjectHasAppleCarePurchaseAddedAuditEventSubjectHasAppleCarePurchaseRemovedAuditEventSubjectHasApplecarePurchaseAddedAttributesAuditEventSubjectHasApplecarePurchaseRemovedAttributesAuditEventSubjectHasICloudStoragePurchaseAddedAuditEventSubjectHasICloudStoragePurchaseRemovedAuditEventSubjectHasIcloudStoragePurchaseAddedAttributesAuditEventSubjectHasIcloudStoragePurchaseRemovedAttributesAuditEventSubscriptionCreatedAuditEventSubscriptionCreatedAttributesAuditEventSubscriptionDeletedAuditEventSubscriptionDeletedAttributesAuditEventSubscriptionUpdatedAuditEventSubscriptionUpdatedAttributesMdmServerCreateRequestMdmServerUpdateRequest