CIPP-API Documentation (1.0.1)
CIPP-API is an Azure Function App operating as the logic layer for the CIPP platform. It is composed primarily of standard Azure Functions with a handful of Azure Durable Functions handling more complex actions (mostly applying standards and running tenant analysis).
API documentation is primarily intended to aid in further development of the CIPP platform.
CIPP-API is primarily intended to be used by the CIPP Azure function app and as-such does not manage
authentication directly. You can authenticate directly to CIPP-API by retrieving the auth cookie
StaticWebAppsAuthCookie
and passing it with your API request.
Response samples
- 200
Content type
application/json
{- "id": 0,
- "displayName": "string",
- "customer": "string",
- "tenantID": 0,
- "createdDateTime": "string",
- "modifiedDateTime": "string",
- "state": "string",
- "clientAppTypes": "string",
- "includePlatforms": "string",
- "excludePlatforms": "string",
- "includeLocations": "string",
- "excludeLocations": "string",
- "includeApplications": "string",
- "excludeApplications": "string",
- "includeUserActions": "string",
- "includeAuthenticationContextClassReferences": "string",
- "includeUsers": "string",
- "excludeUsers": "string",
- "includeGroups": "string",
- "excludeGroups": "string",
- "includeRoles": "string",
- "excludeRoles": "string",
- "grantControlsOperator": "string",
- "builtInControls": "string",
- "customAuthenticationFactors": "string",
- "termsOfUse": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "deploymentProfileAssignmentStatus": "string",
- "deploymentProfileAssignmentDetailedStatus": "string",
- "deploymentProfileAssignedDateTime": "string",
- "groupTag": "string",
- "purchaseOrderIdentifier": "string",
- "serialNumber": "string",
- "productKey": "string",
- "manufacturer": "string",
- "model": "string",
- "enrollmentState": "string",
- "lastContactedDateTime": "string",
- "addressableUserName": "string",
- "userPrincipalName": "string",
- "resourceName": "string",
- "skuNumber": "string",
- "systemFamily": "string",
- "azureActiveDirectoryDeviceId": "string",
- "azureAdDeviceId": "string",
- "managedDeviceId": "string",
- "displayName": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "displayName": "string",
- "description": "string",
- "publisher": "string",
- "largeIcon": "string",
- "createdDateTime": "string",
- "lastModifiedDateTime": "string",
- "isFeatured": true,
- "privacyInformationUrl": "string",
- "informationUrl": "string",
- "owner": "string",
- "developer": "string",
- "notes": "string",
- "uploadState": 0,
- "publushingState": "string",
- "isAssigned": true,
- "roleScopeTagIds": [ ],
- "dependentAppCount": 0,
- "supersedingAppCount": 0,
- "supersededAppCount": 0,
- "committedContentVersion": "string",
- "fileName": "string",
- "size": 0,
- "installCommandLine": "string",
- "uninstallCommandLine": "string",
- "applicableArchitectures": "string",
- "minimumFreeDiskSpaceInMB": "string",
- "minimumMemoryInMB": "string",
- "minimumNUmberOfProcessors": "string",
- "minimumCpuSpeedInMhz": "string",
- "msiInformation": "string",
- "setupFilePath": "string",
- "minimumSupportedWindowsRelease": "string",
- "displayVersion": "string",
- "minimumSupportedOperatingSystem": {
- "v8.0": true,
- "v8_1": true,
- "v10_0": true,
- "v10_1607": true,
- "v10_1703": true,
- "v10_1709": true,
- "v10_1803": true,
- "v10_1809": true,
- "v10_1903": true,
- "v10:1909": true,
- "v10_2004": true,
- "v10_2H20": true,
- "v10_21H2": true
}, - "detectionRules": {
- "path": "string",
- "fileOrFolderName": "string",
- "check32BitOn64System": true,
- "detectionType": "string",
- "operator": "string",
- "detectionValue": "string"
}, - "requirementRules": [ ],
- "rules": {
- "ruleType": "string",
- "path": "string",
- "fileOrFolderName": "string",
- "check32BitOn64System:": true,
- "operationType": "string",
- "operator": "string",
- "comparisonValue": "string"
}, - "installExperience": {
- "runAsAccount": "string",
- "deviceRestartBehaviour": "string"
}, - "returnCodes": {
- "returnCode": 0,
- "type": "string"
}
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "DeviceName": "string",
- "UserPrincipalName": "string",
- "Platform": "string",
- "AppVersion": "string",
- "InstallState": "string",
- "InstallStateDetail": "string",
- "lastModifiedDateTime": "string",
- "DeviceId": "string",
- "ErrorCode": "string",
- "UserName": "string",
- "UserId": "string",
- "ApplicationId": "string",
- "AssignmentFilterIdsList": "string",
- "AppInstallState": "string",
- "AppInstallStateDetails": "string",
- "HexErrorCode": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "displayName": "string",
- "description": "string",
- "language": "string",
- "createdDateTime": "string",
- "lastModifiedDateTime": "string",
- "enrollmentStatusScreenSettings": "string",
- "extractHardwareHash": true,
- "deviceNameTemplate": "string",
- "deviceType": "string",
- "enableWhiteGlove": true,
- "roleScopeTagIds": [ ],
- "managementServiceAppId": "string",
- "outOfBoxExperienceSettings": {
- "hidePrivacySettings": true,
- "hideEULA": true,
- "userType": "string",
- "deviceUsageType": "string",
- "skipKeyboardSelectionPage": true,
- "hideEscapeLink": true
}
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "organizationId": "string",
- "organizationDisplayName": "string",
- "managedDeviceId": "string",
- "managedDeviceName": "string",
- "malwareProtectionEnabled": true,
- "managedDeviceHealthState": "string",
- "realTimeProtectionEnabled": true,
- "networkInspectionSystemEnabled": true,
- "quickScanOverdue": true,
- "fullScanOverdue": true,
- "signatureUpdateOverdue": true,
- "rebootRequired": true,
- "attentionRequired": true,
- "fullScanRequired": true,
- "engineVersion": "string",
- "signatureVersion": "string",
- "antiMalwareVersion": "string",
- "lastQuickScanDateTime": "string",
- "lastFullScanDateTime": "string",
- "lastQuickScanSignatureVersion": "string",
- "lastFullScanSignatureVersion": "string",
- "lastReportedDateTime": "string",
- "devicePropertiesRefreshTime": "string",
- "deviceDeleted": true,
- "lastRefreshDateTime": "string",
- "tenantID": "string",
- "tenantDisplayName": "string",
- "devicePropertiesRefreshDateTime": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "accountEnabled": true,
- "approximateLastSignInDateTime": "string",
- "createdDateTime": "string",
- "deviceOwnership": "string",
- "displayName": "string",
- "enrollmentType": "string",
- "isCompliant": true,
- "managementType": "string",
- "manufacturer": "string",
- "model": "string",
- "operatingSystem": "string",
- "onPremisessSyncEnabled": true,
- "operatingSystemVersion": "string",
- "trustType": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "authenticationType": "string",
- "availabilityStatus": "string",
- "isAdminManaged": true,
- "isDefault": true,
- "isInitial": true,
- "isRoot": true,
- "isVerified": true,
- "supportedServices": [ ],
- "passwordValidityPeriodInDays": 0,
- "passwordNotificationWindowInDays": 0,
- "state": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "authenticationType": "string",
- "availabilityStatus": "string",
- "isAdminManaged": true,
- "isDefault": true,
- "isInitial": true,
- "isRoot": true,
- "isVerified": true,
- "supportedServices": [ ],
- "passwordValidityPeriodInDays": 0,
- "passwordNotificationWindowInDays": 0,
- "state": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "createdDateTime": "string",
- "displayName": "string",
- "description": "string",
- "mail": "string",
- "mailEnabled": true,
- "mailNickname": "string",
- "resourceProvisioningOptions": "string",
- "securityEnabled": true,
- "visibility": "string",
- "organizationId": "string",
- "onPremisessSamAccountName": "string",
- "membershipRule": "string",
- "groupTypes": "string",
- "onPremisessSyncEnabled": true,
- "GroupID": {
- "id": "string",
- "createdDateTime": "string",
- "displayName": "string",
- "description": "string",
- "mail": "string",
- "mailEnabled": true,
- "mailNickname": "string",
- "resourceProvisioningOptions": "string",
- "securityEnabled": true,
- "visibility": "string",
- "organizationId": "string",
- "onPremisessSamAccountName": "string",
- "membershipRule": "string"
}, - "members": {
- "id": "string",
- "createdDateTime": "string",
- "displayName": "string",
- "description": "string",
- "mail": "string",
- "mailEnabled": true,
- "mailNickname": "string",
- "resourceProvisioningOptions": "string",
- "securityEnabled": true,
- "visibility": "string",
- "organizationId": "string",
- "onPremisessSamAccountName": "string",
- "membershipRule": "string",
- "hideFromOutlookClients": true,
- "hideFromAddressLists": true
}, - "owners": {
- "id": "string",
- "createdDateTime": "string",
- "displayName": "string",
- "description": "string",
- "mail": "string",
- "mailEnabled": true,
- "mailNickname": "string",
- "resourceProvisioningOptions": "string",
- "securityEnabled": true,
- "visibility": "string",
- "organizationId": "string",
- "onPremisessSamAccountName": "string",
- "membershipRule": "string",
- "hideFromOutlookClients": true,
- "hideFromAddressLists": true
}
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "capabilityStatus": "string",
- "consumedUnits": 0,
- "skuID": "string",
- "skuPartNumber": "string",
- "appliesTo": "string",
- "prepaidUnits": {
- "enabled": 0,
- "suspended": 0,
- "warning": 0
}, - "servicePlans": {
- "servicePlanId": "string",
- "servicePlanName": "string",
- "provisioningStatus": "string",
- "appliesTo": "string"
}
}
Response samples
- 200
Content type
application/json
{- "displayName": "string",
- "primarySmtpAddress": "string",
- "ecpenabled": true,
- "owaenabled": true,
- "imapenabled": true,
- "popenabled": true,
- "mapienabled": true,
- "ewsenabled": true,
- "activesyncenabled": true
}
Response samples
- 200
Content type
application/json
{- "clientType": "string",
- "clientVersion": 0,
- "deviceAccessState": "string",
- "deviceFriendlyName": "string",
- "deviceModel": "string",
- "deviceOS": "string",
- "deviceType": "string",
- "firstSync": "string",
- "lastSyncAttempt": "string",
- "lastSuccessSync": "string",
- "status": "string"
}
Response samples
- 200
Content type
application/json
{- "AssignedTo": "string",
- "TelephoneNumber": "string",
- "NumberType": "string",
- "IsoCountryCode": "string",
- "PlaceName": "string",
- "ActivationState": "string",
- "IsOperatorConnect": "string",
- "AcquisitionDate": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "accountEnabled": true,
- "approximateLastSignInDateTime": "string",
- "createdDateTime": "string",
- "deviceOwnership": "string",
- "displayName": "string",
- "enrollmentType": "string",
- "isCompliant": true,
- "managementType": "string",
- "manufacturer": "string",
- "model": "string",
- "operatingSystem": "string",
- "onPremisessSyncEnabled": true,
- "operatingSystemVersion": "string",
- "trustType": "string",
- "EPMID": "string"
}
Response samples
- 200
Content type
application/json
{- "displayName": "string",
- "mailEnabled": true,
- "mail": "string",
- "securityEnabled": true,
- "groupTypes": "string",
- "onPremisesSyncEnabled": true,
- "isAssignableToRole": true
}
Response samples
- 200
Content type
application/json
{- "DeliverToMailboxAndForward": true,
- "ForwardingAddress": "string",
- "LitigationHoldEnabled": true,
- "HiddenFromAddressListsEnabled": true,
- "EwsEnabled": "string",
- "MAPIEnabled": true,
- "OWAEnabled": true,
- "ImapEnabled": "string",
- "PopEnabled": true,
- "ActiveSyncEnabled": true,
- "Permissions": "string",
- "ProhibitSendQuota": 0,
- "ProhibitSendReceiveQuota": 0,
- "ItemCount": 0,
- "TotalItemSize": 0,
- "BlockedForSpam": true
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "accountEnabled": true,
- "businessPhones": [ ],
- "city": "string",
- "createdDateTime": "string",
- "companyName": "string",
- "country": "string",
- "department": "string",
- "faxNumber": "string",
- "givenName": "string",
- "isResourceAccount": "string",
- "jobTitle": "string",
- "mail": "string",
- "mailNickname": "string",
- "mobilePhone": "string",
- "onPremisesDistinguishedName": "string",
- "officeLocation": "string",
- "onPremisesLastSyncDateTime": "string",
- "otherMails": [ ],
- "postalCode": "string",
- "preferredDataLocation": "string",
- "preferredLanguage": "string",
- "proxyAddresses": [ ],
- "showInAddressList": "string",
- "state": "string",
- "streetAddress": "string",
- "surname": "string",
- "usageLocation": "string",
- "userPrincipalName": "string",
- "userType": "string",
- "assignedLicenses": [ ],
- "onPremisessSyncEnabled": true,
- "LicJoined": "string",
- "Aliases": "string",
- "primDomain": "string",
- "LastSignInApplication": "string",
- "LastSignInDate": "string",
- "LastSignInStatus": "string",
- "LastSignInResult": "string",
- "LastSigninFailureReason": "string"
}
Response samples
- 200
Content type
application/json
{- "Date": "string",
- "Application": "string",
- "LoginStatus": "string",
- "ConditionalAccessStatus": "string",
- "OverallLoginStatus": "string",
- "IPAddress": "string",
- "Town": "string",
- "State": "string",
- "Country": "string",
- "Device": "string",
- "DeviceCompliant": "string",
- "OS": "string",
- "Browser": "string",
- "AppliedCAPs": "string",
- "AdditionalDetails": "string",
- "FailureReason": "string",
- "FullDetails": "string"
}