Skip to main content

CIPP-API Documentation (1.0.1)

An overview of the CIPP-API functions

Conditional Access Policies

List Conditional Access Policies

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Autopilot Devices

List Autopilot Devices

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Endpoint Applications

List Applications

path Parameters
tenantId
required
string

Responses

Response samples

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": {
    },
  • "detectionRules": {
    },
  • "requirementRules": [ ],
  • "rules": {
    },
  • "installExperience": {
    },
  • "returnCodes": {
    }
}

Endpoint Application Status

List Application Status

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Autopilot Configuration

List Autopilot Config

path Parameters
tenantId
required
string

Responses

Response samples

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": {
    }
}

Basic Authentication Status

List Basic Auth Status

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UPN": "string",
  • "BasicAuth": "string"
}

Contacts

List Contacts

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "companyName": "string",
  • "displayName": "string",
  • "mail": "string",
  • "onPremisessSyncEnabled": true
}

Defender State

List Defender State

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Endpoint Devices

List Endpoint Devices

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Domain Information

List Domains

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Domain Tests

List Domains

Responses

Response samples

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"
}

Group Information

List Groups

path Parameters
tenantId
required
string

Responses

Response samples

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": {
    },
  • "members": {
    },
  • "owners": {
    }
}

Endpoint Policies

List Endpoint Policies

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

Licences Information

List Licence SKU Information

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "capabilityStatus": "string",
  • "consumedUnits": 0,
  • "skuID": "string",
  • "skuPartNumber": "string",
  • "appliesTo": "string",
  • "prepaidUnits": {
    },
  • "servicePlans": {
    }
}

Log Information

List Log Information

Responses

Response samples

Content type
application/json
{
  • "DateTime": "string",
  • "Tenant": "string",
  • "API": "string",
  • "Message": "string",
  • "User": "string",
  • "Severity": "string"
}

Exchange Mailbox CAS

List Exchange Mailbox CAS Information

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "primarySmtpAddress": "string",
  • "ecpenabled": true,
  • "owaenabled": true,
  • "imapenabled": true,
  • "popenabled": true,
  • "mapienabled": true,
  • "ewsenabled": true,
  • "activesyncenabled": true
}

Exchange Mailboxes

List Exchange Mailboxes

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UPN": "string",
  • "displayName": "string",
  • "primarySmtpAddress": "string",
  • "recipientType": "string",
  • "recipientTypeDetails": "string",
  • "AdditionalEmailAddresses": "string"
}

Exchange Mailbox Mobile Devices

List Exchange Mailbox Devices

path Parameters
tenantId
required
string

Responses

Response samples

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"
}

Exchange Mailbox Permissions

List Exchange Mailbox Permissions

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "User": "string",
  • "AccessRights": "string"
}

Exchange Mailbox Statistics

List Exchange Mailbox Statistics

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UPN": "string",
  • "displayName": "string",
  • "LastActive": "string",
  • "UsedGB": "string",
  • "ItemCount": 0,
  • "HasArchive": true
}

Exchange Message Trace

Exchange Message Trace

path Parameters
tenantId
required
string
days
required
string

Responses

Response samples

Content type
application/json
{
  • "Date": "string",
  • "Recipient": "string",
  • "Sender": "string",
  • "Subject": "string",
  • "Status": 0
}

MFA Status

List MFA Status

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UserPrincipalName": "string",
  • "AccountState": "string",
  • "PerUser": "string",
  • "MFARegUser": "string",
  • "SecureDefaultState": "string"
}

Exchange Phish Policies

List Exchange Phish Policies

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "Name": "string",
  • "PhishThresholdLevel": "string",
  • "Enabled": true,
  • "ExcludedSenders": "string",
  • "ExcludedDomains": "string",
  • "WhenChangedUTC": "string",
  • "Priority": "string"
}

Roles

List Roles

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "Members": true
}

Sharepoint Sites

List Sharepoint Sites

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UPN": "string",
  • "displayName": "string",
  • "LastActive": "string",
  • "FileCount": 0,
  • "UsedGB": 0,
  • "URL": "string",
  • "Allocated": 0
}

Applied Standards

List Applied Standards

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "standardName": "string",
  • "appliedBy": "string"
}

Teams Sites Inforamtion

List Teams Sites

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "team": "string",
  • "channels": "string",
  • "Members": "string",
  • "ownerse": "string",
  • "AppsList": "string"
}

Teams Sites Activity

List Teams Activity

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "UPN": "string",
  • "LastActive": "string",
  • "TeamsChat": 0,
  • "CallCount": 0,
  • "MeetingCount": 0
}

Teams Voice Information

List Teams Voice Information

path Parameters
tenantId
required
string

Responses

Response samples

Content type
application/json
{
  • "AssignedTo": "string",
  • "TelephoneNumber": "string",
  • "NumberType": "string",
  • "IsoCountryCode": "string",
  • "PlaceName": "string",
  • "ActivationState": "string",
  • "IsOperatorConnect": "string",
  • "AcquisitionDate": "string"
}

Tenants Information

List Tenants

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "deletedDateTime": "string",
  • "contractType": 0,
  • "customerId": "string",
  • "defaultDomainName": "string",
  • "displayName": "string"
}

User Conditional Access Policies

List User Conditional Access Policies

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string"
}

User Endpoint Devices

List User Endpoint Devices

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

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"
}

User Group Inforamtion

List User Groups

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "displayName": "string",
  • "mailEnabled": true,
  • "mail": "string",
  • "securityEnabled": true,
  • "groupTypes": "string",
  • "onPremisesSyncEnabled": true,
  • "isAssignableToRole": true
}

User Mailbox Information

List User Mailbox Details

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

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
}

User Information

List User Information

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

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"
}

User Sign In Logs

List User Sign In Logs

path Parameters
tenantId
required
string
userId
required
string

Responses

Response samples

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"
}