API docs by Redocly

CIPP API (auto)

Download OpenAPI specification:

CIPP-API is an Azure Function App providing the logic layer for the CIPP platform. This spec is auto-generated via static analysis of both the API (PowerShell) and frontend (React/Next.js) repositories.

Endpoint > Autopilot

AddAPDevice

Adds Autopilot devices to a tenant via Partner Center API #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
autopilotData
string
Groupname
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "autopilotData": "string",
  • "Groupname": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddAutopilotConfig

Authorizations:
bearerAuth
Request Body schema: application/json
required
allowWhiteGlove
boolean
Assignto
boolean
Autokeyboard
boolean
CollectHash
boolean
DeploymentMode
boolean
Description
string
DeviceNameTemplate
string
DisplayName
string
HideChangeAccount
boolean
HidePrivacy
boolean
HideTerms
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

NotLocalAdmin
boolean
selectedTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "allowWhiteGlove": true,
  • "Assignto": true,
  • "Autokeyboard": true,
  • "CollectHash": true,
  • "DeploymentMode": true,
  • "Description": "string",
  • "DeviceNameTemplate": "string",
  • "DisplayName": "string",
  • "HideChangeAccount": true,
  • "HidePrivacy": true,
  • "HideTerms": true,
  • "languages": {
    },
  • "NotLocalAdmin": true,
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddEnrollment

Authorizations:
bearerAuth
Request Body schema: application/json
required
AllowFail
boolean
AllowReset
boolean
blockDevice
boolean
EnableLog
boolean
ErrorMessage
string
InstallWindowsUpdates
boolean
OBEEOnly
boolean
selectedTenants
string
ShowProgress
boolean
TimeOutInMinutes
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AllowFail": true,
  • "AllowReset": true,
  • "blockDevice": true,
  • "EnableLog": true,
  • "ErrorMessage": "string",
  • "InstallWindowsUpdates": true,
  • "OBEEOnly": true,
  • "selectedTenants": "string",
  • "ShowProgress": true,
  • "TimeOutInMinutes": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAssignAPDevice

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
device
string
serialNumber
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "device": "string",
  • "serialNumber": "string",
  • "tenantFilter": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRenameAPDevice

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
deviceId
string
displayName
string
serialNumber
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "displayName": "string",
  • "serialNumber": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetAPDeviceGroupTag

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
deviceId
string
groupTag
string
serialNumber
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "groupTag": "string",
  • "serialNumber": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSyncAPDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAPDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAutopilotconfig

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveAPDevice

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveAutopilotConfig

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
assignments
string
displayName
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "assignments": "string",
  • "displayName": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Administration > Alerts

AddAlert

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

CustomSubject
string
actions
Array of strings

actions parameter

AlertComment
string

AlertComment parameter

object

command parameter

conditions
string

conditions parameter

excludedTenants
string

excludedTenants parameter

object

logbook parameter

postExecution
Array of strings

postExecution parameter

object

preset parameter

object

recurrence parameter

RowKey
string

RowKey parameter

startDateTime
string <date-time>

startDateTime parameter

count
string

Body parameter from PS1: count

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "CustomSubject": "string",
  • "actions": [
    ],
  • "AlertComment": "string",
  • "command": {
    },
  • "conditions": "string",
  • "excludedTenants": "string",
  • "logbook": {
    },
  • "postExecution": [
    ],
  • "preset": {
    },
  • "recurrence": {
    },
  • "RowKey": "string",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "tenantFilter": "string",
  • "count": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddScriptedAlert

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Array of objects (LabelValue)
AlertComment
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

CustomSubject
string
excludedTenants
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Array of objects (LabelValue)
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

PSObject
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

RowKey
string
startDateTime
string <date-time>

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Actions": [
    ],
  • "AlertComment": "string",
  • "command": {
    },
  • "CustomSubject": "string",
  • "excludedTenants": "string",
  • "logbook": {
    },
  • "postExecution": [
    ],
  • "preset": {
    },
  • "PSObject": "string",
  • "recurrence": {
    },
  • "RowKey": "string",
  • "startDateTime": "2019-08-24T14:15:22Z",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAuditLogSearch

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Action
string

Action parameter

SearchId
string

SearchId parameter

Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

Action
string

Action parameter

EndTime
string

EndTime parameter

SearchId
string

SearchId parameter

StartTime
string

StartTime parameter

PSObject
string

Body parameter from PS1: PSObject

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "EndTime": "string",
  • "SearchId": "string",
  • "StartTime": "string",
  • "tenantFilter": "string",
  • "PSObject": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAlertsQueue

Authorizations:
bearerAuth
Request Body schema: application/json
required
CustomSubject
string
preset
string

(auto) detected in frontend form/call

logbook
string

(auto) detected in frontend form/call

Actions
string

(auto) detected in frontend form/call

AlertComment
string

(auto) detected in frontend form/call

command
string

(auto) detected in frontend form/call

recurrence
string

(auto) detected in frontend form/call

startDateTime
string

(auto) detected in frontend form/call

postExecution
string

(auto) detected in frontend form/call

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "CustomSubject": "string",
  • "preset": "string",
  • "logbook": "string",
  • "Actions": "string",
  • "AlertComment": "string",
  • "command": "string",
  • "recurrence": "string",
  • "startDateTime": "string",
  • "postExecution": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAuditLogSearches

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Days
string
SearchId
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAuditLogTest

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

SearchId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAuditLogs

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

EndDate
string
LogId
string
RelativeTime
string
StartDate
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListWebhookAlert

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

PublicWebhooks

Authorizations:
bearerAuth
query Parameters
CIPPID
string
Type
string
validationCode
string
ValidationToken
string
Request Body schema: application/json
required
validationCode
string
value
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "validationCode": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveQueuedAlert

Authorizations:
bearerAuth
query Parameters
EventType
string
ID
string
Request Body schema: application/json
required
EventType
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "EventType": "string",
  • "ID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Endpoint > Applications

AddAppTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
AcceptLicense
boolean
applicationName
string
apps
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

arch
boolean
AssignTo
string
Enum: "On" "allLicensedUsers" "AllDevices" "AllDevicesAndUsers" "customGroup"
customArguments
string
customGroup
string
customRepo
string
customXml
string
description
string
detectionFile
string
detectionPath
string
detectionScript
string
DisableRestart
boolean
displayName
string
enforceSignatureCheck
boolean
Array of objects (LabelValue)
GUID
string
InstallAsSystem
boolean
InstallationIntent
boolean
installScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

packagename
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

publisher
string
RemoveVersions
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

runAs32Bit
boolean
searchQuery
string
SharedComputerActivation
boolean
templateDescription
string
templateName
string
uninstallScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

useCustomXml
boolean
useDetectionScript
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AcceptLicense": true,
  • "applicationName": "string",
  • "apps": "string",
  • "appType": {
    },
  • "arch": true,
  • "AssignTo": "On",
  • "customArguments": "string",
  • "customGroup": "string",
  • "customRepo": "string",
  • "customXml": "string",
  • "description": "string",
  • "detectionFile": "string",
  • "detectionPath": "string",
  • "detectionScript": "string",
  • "DisableRestart": true,
  • "displayName": "string",
  • "enforceSignatureCheck": true,
  • "excludedApps": [
    ],
  • "GUID": "string",
  • "InstallAsSystem": true,
  • "InstallationIntent": true,
  • "installScript": "string",
  • "languages": {
    },
  • "packagename": "string",
  • "packageSearch": {
    },
  • "publisher": "string",
  • "RemoveVersions": true,
  • "rmmname": {
    },
  • "runAs32Bit": true,
  • "searchQuery": "string",
  • "SharedComputerActivation": true,
  • "templateDescription": "string",
  • "templateName": "string",
  • "uninstallScript": "string",
  • "updateChannel": {
    },
  • "useCustomXml": true,
  • "useDetectionScript": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddChocoApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
ApplicationName
string

ApplicationName parameter

AssignTo
string

AssignTo parameter

customArguments
string

customArguments parameter

CustomGroup
string

CustomGroup parameter

description
string

description parameter

DisableRestart
string

DisableRestart parameter

InstallAsSystem
string

InstallAsSystem parameter

InstallationIntent
string

InstallationIntent parameter

PackageName
string

PackageName parameter

selectedTenants
string

selectedTenants parameter

CustomRepo
string

Body parameter from PS1: CustomRepo

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ApplicationName": "string",
  • "AssignTo": "string",
  • "customArguments": "string",
  • "CustomGroup": "string",
  • "description": "string",
  • "DisableRestart": "string",
  • "InstallAsSystem": "string",
  • "InstallationIntent": "string",
  • "PackageName": "string",
  • "selectedTenants": "string",
  • "CustomRepo": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddMSPApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
AssignTo
string

AssignTo parameter

CustomGroup
string

CustomGroup parameter

DisplayName
string

DisplayName parameter

PackageName
string

PackageName parameter

params
string

params parameter

object

RMMName parameter

selectedTenants
string

selectedTenants parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AssignTo": "string",
  • "CustomGroup": "string",
  • "DisplayName": "string",
  • "PackageName": "string",
  • "params": "string",
  • "RMMName": {
    },
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddOfficeApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
AcceptLicense
string
arch
string
AssignTo
string
CustomGroup
string
customXml
string
excludedApps
string
IntuneBody
string
languages
string
RemoveVersions
string
selectedTenants
string
SharedComputerActivation
string
updateChannel
string
useCustomXml
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AcceptLicense": "string",
  • "arch": "string",
  • "AssignTo": "string",
  • "CustomGroup": "string",
  • "customXml": "string",
  • "excludedApps": "string",
  • "IntuneBody": "string",
  • "languages": "string",
  • "RemoveVersions": "string",
  • "selectedTenants": "string",
  • "SharedComputerActivation": "string",
  • "updateChannel": "string",
  • "useCustomXml": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddStoreApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
ApplicationName
string

ApplicationName parameter

AssignTo
string

AssignTo parameter

CustomGroup
string

CustomGroup parameter

description
string

description parameter

InstallationIntent
string

InstallationIntent parameter

PackageName
string

PackageName parameter

selectedTenants
string

selectedTenants parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ApplicationName": "string",
  • "AssignTo": "string",
  • "CustomGroup": "string",
  • "description": "string",
  • "InstallationIntent": "string",
  • "PackageName": "string",
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddWin32ScriptApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
detectionScript
string
AssignTo
string

AssignTo parameter

CustomGroup
string

CustomGroup parameter

description
string

description parameter

detectionFile
string

detectionFile parameter

detectionPath
string

detectionPath parameter

DisableRestart
string

DisableRestart parameter

enforceSignatureCheck
string

enforceSignatureCheck parameter

InstallAsSystem
string

InstallAsSystem parameter

InstallationIntent
string

InstallationIntent parameter

installScript
string

installScript parameter

publisher
string

publisher parameter

runAs32Bit
string

runAs32Bit parameter

selectedTenants
string

selectedTenants parameter

uninstallScript
string

uninstallScript parameter

applicationName
string

Body parameter from PS1: applicationName

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "detectionScript": "string",
  • "AssignTo": "string",
  • "CustomGroup": "string",
  • "description": "string",
  • "detectionFile": "string",
  • "detectionPath": "string",
  • "DisableRestart": "string",
  • "enforceSignatureCheck": "string",
  • "InstallAsSystem": "string",
  • "InstallationIntent": "string",
  • "installScript": "string",
  • "publisher": "string",
  • "runAs32Bit": "string",
  • "selectedTenants": "string",
  • "uninstallScript": "string",
  • "applicationName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAppUpload

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAssignApp

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AppType
string
AssignTo
string
GroupIds
string
GroupNames
string
ID
string
Intent
string
Request Body schema: application/json
required
tenantFilter
required
string
AppType
string
AssignmentFilterName
string
AssignmentFilterType
string
assignmentMode
string
AssignTo
string
GroupIds
string
GroupNames
string
ID
string
Intent
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AppType": "string",
  • "AssignmentFilterName": "string",
  • "AssignmentFilterType": "string",
  • "assignmentMode": "string",
  • "AssignTo": "string",
  • "GroupIds": "string",
  • "GroupNames": "string",
  • "ID": "string",
  • "Intent": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDeployAppTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
AssignTo
string
customGroup
string
selectedTenants
string
templateId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AssignTo": "string",
  • "customGroup": "string",
  • "selectedTenants": "string",
  • "templateId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSyncVPP

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListApplicationQueue

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListApps

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppsRepository

Authorizations:
bearerAuth
Request Body schema: application/json
required
AcceptLicense
boolean
applicationName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

arch
boolean
AssignTo
string
Enum: "On" "allLicensedUsers" "AllDevices" "AllDevicesAndUsers" "customGroup"
customArguments
string
customGroup
string
customRepo
string
customXml
string
description
string
detectionFile
string
detectionPath
string
detectionScript
string
DisableRestart
boolean
displayName
string
enforceSignatureCheck
boolean
Array of objects (LabelValue)
InstallAsSystem
boolean
InstallationIntent
boolean
installScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

packagename
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object
publisher
string
RemoveVersions
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

runAs32Bit
boolean
SharedComputerActivation
boolean
templateDescription
string
templateName
string
uninstallScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

useCustomXml
boolean
useDetectionScript
boolean
Search
string

(auto) API uses 'Search', frontend sends 'searchQuery' — likely the same field (similarity=0.71). Verify and correct type.

Repository
string

Body parameter from PS1: Repository

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AcceptLicense": true,
  • "applicationName": "string",
  • "appType": {
    },
  • "arch": true,
  • "AssignTo": "On",
  • "customArguments": "string",
  • "customGroup": "string",
  • "customRepo": "string",
  • "customXml": "string",
  • "description": "string",
  • "detectionFile": "string",
  • "detectionPath": "string",
  • "detectionScript": "string",
  • "DisableRestart": true,
  • "displayName": "string",
  • "enforceSignatureCheck": true,
  • "excludedApps": [
    ],
  • "InstallAsSystem": true,
  • "InstallationIntent": true,
  • "installScript": "string",
  • "languages": {
    },
  • "packagename": "string",
  • "packageSearch": {
    },
  • "params": {
    },
  • "publisher": "string",
  • "RemoveVersions": true,
  • "rmmname": {
    },
  • "runAs32Bit": true,
  • "SharedComputerActivation": true,
  • "templateDescription": "string",
  • "templateName": "string",
  • "uninstallScript": "string",
  • "updateChannel": {
    },
  • "useCustomXml": true,
  • "useDetectionScript": true,
  • "Search": "string",
  • "Repository": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveApp

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveAppTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveQueuedApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Endpoint > MEM

AddAssignmentFilter

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

(auto) from API scan

displayName
string

(auto) from CippAddAssignmentFilterForm.jsx

description
string

(auto) from CippAddAssignmentFilterForm.jsx

assignmentFilterManagementType
string
Enum: "devices" "apps"

(auto) from CippAddAssignmentFilterForm.jsx

platform
string

(auto) from CippAddAssignmentFilterForm.jsx

rule
string

(auto) from CippAddAssignmentFilterForm.jsx

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "assignmentFilterManagementType": "devices",
  • "platform": "string",
  • "rule": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddAssignmentFilterTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
GUID
string

(auto) from CippAddAssignmentFilterTemplateForm.jsx

assignmentFilterManagementType
string
Enum: "devices" "apps"

(auto) from CippAddAssignmentFilterTemplateForm.jsx

platform
string

(auto) from CippAddAssignmentFilterTemplateForm.jsx

rule
string

(auto) from CippAddAssignmentFilterTemplateForm.jsx

displayname
string

Body parameter from PS1: displayname

Description
string

Body parameter from PS1: Description

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "assignmentFilterManagementType": "devices",
  • "platform": "string",
  • "rule": "string",
  • "displayname": "string",
  • "Description": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddDefenderDeployment

Authorizations:
bearerAuth
Request Body schema: application/json
required
object

Compliance parameter

object

ASR parameter

object

EDR parameter

object

Exclusion parameter

object

Policy parameter

selectedTenants
string

selectedTenants parameter

showASR
boolean

showASR parameter

showDefenderDefaults
boolean

showDefenderDefaults parameter

showDefenderSetup
boolean

showDefenderSetup parameter

showExclusionPolicy
boolean

showExclusionPolicy parameter

appSync
string

Body parameter from PS1: appSync

ConnectIos
string

Body parameter from PS1: ConnectIos

ConnectAndroid
string

Body parameter from PS1: ConnectAndroid

ConnectIosCompliance
string

Body parameter from PS1: ConnectIosCompliance

BlockunsupportedOS
string

Body parameter from PS1: BlockunsupportedOS

ConnectMac
string

Body parameter from PS1: ConnectMac

Connectwindows
string

Body parameter from PS1: Connectwindows

ConnectAndroidCompliance
string

Body parameter from PS1: ConnectAndroidCompliance

AssignTo
string

Body parameter from PS1: AssignTo

excludedExtensions
string

Body parameter from PS1: excludedExtensions

excludedProcesses
string

Body parameter from PS1: excludedProcesses

excludedPaths
string

Body parameter from PS1: excludedPaths

Mode
string

Body parameter from PS1: Mode

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Compliance": {
    },
  • "ASR": {
    },
  • "EDR": {
    },
  • "Exclusion": {
    },
  • "Policy": {
    },
  • "selectedTenants": "string",
  • "showASR": true,
  • "showDefenderDefaults": true,
  • "showDefenderSetup": true,
  • "showExclusionPolicy": true,
  • "appSync": "string",
  • "ConnectIos": "string",
  • "ConnectAndroid": "string",
  • "ConnectIosCompliance": "string",
  • "BlockunsupportedOS": "string",
  • "ConnectMac": "string",
  • "Connectwindows": "string",
  • "ConnectAndroidCompliance": "string",
  • "AssignTo": "string",
  • "excludedExtensions": "string",
  • "excludedProcesses": "string",
  • "excludedPaths": "string",
  • "Mode": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddDefenderTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
ASR
string
EDR
string
Exclusion
string
package
string
Policy
string
templateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ASR": "string",
  • "EDR": "string",
  • "Exclusion": "string",
  • "package": "string",
  • "Policy": "string",
  • "templateName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddIntuneReusableSetting

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

TemplateId
string

Query parameter from PS1: TemplateId

Request Body schema: application/json
required
tenantFilter
required
string

Target tenant. PS1 also checks $Request.Query.tenantFilter.

ID
string

ID of the IntuneReusableSettingTemplate to deploy; sent as 'TemplateId' in older path. PS1 reads $Request.Body.TemplateId ?? $Request.Body.TemplateList?.value ?? $Request.Body.TemplateList. The edit form sends 'ID' and 'TemplateId' both set to the same value.

TemplateId
string

Legacy alias for ID; PS1 resolves TemplateId first then falls back to ID via TemplateList.

displayName
string

Display name to override; propagated into rawJSON by formatter.

description
string
rawJSON
string

Serialised JSON string of the full reusable-policy-setting Graph object. PS1 reads this from the template entity, not directly from the request body — the body only supplies TemplateId.

TemplateList
string

Body parameter from PS1: TemplateList

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "ID": "string",
  • "TemplateId": "string",
  • "displayName": "string",
  • "description": "string",
  • "rawJSON": "string",
  • "TemplateList": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddIntuneReusableSettingTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Used by the edit form; the PS1 for AddIntuneReusableSettingTemplate is AnyTenant so tenantFilter is informational only here.

GUID
string

Template GUID; auto-generated by PS1 if not supplied. Both Add (new) and Edit forms send this.

displayName
string

PS1 reads $Request.Body.displayName ?? $Request.Body.DisplayName ?? $Request.Body.displayname

description
string

PS1 reads $Request.Body.description ?? $Request.Body.Description

rawJSON
string

Serialised JSON string of the full reusable-policy-setting graph object. PS1 reads $Request.Body.rawJSON ?? $Request.Body.RawJSON ?? $Request.Body.json

package
string

Present in the edit-form formatter output but not read by the PS1; likely a passthrough for future use.

DisplayName
string

Body parameter from PS1: DisplayName

displayname
string

Body parameter from PS1: displayname

Description
string

Body parameter from PS1: Description

RawJSON
string

Body parameter from PS1: RawJSON

json
string

Body parameter from PS1: json

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "displayName": "string",
  • "description": "string",
  • "rawJSON": "string",
  • "tenantFilter": "string",
  • "package": "string",
  • "DisplayName": "string",
  • "displayname": "string",
  • "Description": "string",
  • "RawJSON": "string",
  • "json": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddIntuneTemplate

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
ODataType
string
URLName
string
Request Body schema: application/json
required
tenantFilter
required
string
description
string
displayName
string
ID
string
ODataType
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

RawJSON
string
TemplateType
string
URLName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "description": "string",
  • "displayName": "string",
  • "ID": "string",
  • "ODataType": "string",
  • "policySource": {
    },
  • "RawJSON": "string",
  • "TemplateType": "string",
  • "tenantFilter": "string",
  • "URLName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddPolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string

Body parameter from PS1: displayName

Description
string

Body parameter from PS1: Description

AssignTo
string

Body parameter from PS1: AssignTo

excludeGroup
string

Body parameter from PS1: excludeGroup

AssignmentFilterName
string

Body parameter from PS1: AssignmentFilterName

assignmentFilter
string

Body parameter from PS1: assignmentFilter

assignmentFilterType
string

Body parameter from PS1: assignmentFilterType

customGroup
string

Body parameter from PS1: customGroup

RAWJson
string

Body parameter from PS1: RAWJson

replacemap
string

Body parameter from PS1: replacemap

reusableSettings
string

Body parameter from PS1: reusableSettings

TemplateID
string

Body parameter from PS1: TemplateID

TemplateGUID
string

Body parameter from PS1: TemplateGUID

TemplateType
string

Body parameter from PS1: TemplateType

Count
string

Body parameter from PS1: Count

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "displayName": "string",
  • "Description": "string",
  • "AssignTo": "string",
  • "excludeGroup": "string",
  • "AssignmentFilterName": "string",
  • "assignmentFilter": "string",
  • "assignmentFilterType": "string",
  • "customGroup": "string",
  • "RAWJson": "string",
  • "replacemap": "string",
  • "reusableSettings": "string",
  • "TemplateID": "string",
  • "TemplateGUID": "string",
  • "TemplateType": "string",
  • "Count": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditAssignmentFilter

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

(auto) from API scan

displayName
string

(auto) from CippAddAssignmentFilterForm.jsx

description
string

(auto) from CippAddAssignmentFilterForm.jsx

assignmentFilterManagementType
string
Enum: "devices" "apps"

(auto) from CippAddAssignmentFilterForm.jsx

platform
string

(auto) from CippAddAssignmentFilterForm.jsx

rule
string

(auto) from CippAddAssignmentFilterForm.jsx

filterId
string

(auto) from API scan

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "assignmentFilterManagementType": "devices",
  • "platform": "string",
  • "rule": "string",
  • "filterId": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditIntunePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
newDisplayName
string
policyType
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
newDisplayName
string
policyType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "newDisplayName": "string",
  • "policyType": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditIntuneScript

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ScriptId
string
Request Body schema: application/json
required
TenantFilter
required
string
IntuneScript
string
ScriptId
string
ScriptType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "IntuneScript": "string",
  • "ScriptId": "string",
  • "ScriptType": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditPolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
Assignto
string
Description
string
Displayname
string
groupid
string
tenantid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Assignto": "string",
  • "Description": "string",
  • "Displayname": "string",
  • "groupid": "string",
  • "tenantid": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAssignPolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AssignmentFilterName
string
AssignmentFilterType
string
assignmentMode
string
AssignTo
string
excludeGroup
string
GroupIds
string
GroupNames
string
ID
string
platformType
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AssignmentFilterName": "string",
  • "AssignmentFilterType": "string",
  • "assignmentMode": "string",
  • "AssignTo": "string",
  • "excludeGroup": "string",
  • "GroupIds": "string",
  • "GroupNames": "string",
  • "ID": "string",
  • "platformType": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAssignmentFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Request Body schema: application/json
required
tenantFilter
required
string
Action
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCompareIntunePolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
sourceA
string
sourceB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "sourceA": "string",
  • "sourceB": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDeviceAction

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
GUID
string
input
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "GUID": "string",
  • "input": "string",
  • "tenantFilter": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDevicePasscodeAction

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
GUID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "GUID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGetLocalAdminPassword

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
guid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "guid": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGetRecoveryKey

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
RecoveryKeyType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "RecoveryKeyType": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSyncDEP

Syncs devices from Apple Business Manager to Intune #> [CmdletBinding()] param($Request, $TriggerMetadata) $APIName = $Request.Params.CIPPEndpoint $Headers = $Request.Headers

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppProtectionPolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAssignmentFilterTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAssignmentFilters

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

filterId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCompliancePolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDefenderState

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DeviceID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDefenderTVM

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntunePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DefinitionIds
string
ID
string
IncludeSettingDefinitions
string
URLName
string
UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntuneReusableSettingTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntuneReusableSettings

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntuneScript

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntuneTemplates

Authorizations:
bearerAuth
query Parameters
id
string
mode
string
View
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveAssignmentFilterTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveIntuneReusableSetting

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DisplayName
string
ID
string
Request Body schema: application/json
required
tenantFilter
required
string
DisplayName
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "DisplayName": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveIntuneReusableSettingTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveIntuneScript

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
DisplayName
string
ID
string
ScriptType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "DisplayName": "string",
  • "ID": "string",
  • "ScriptType": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveIntuneTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemovePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
URLName
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
URLName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string",
  • "URLName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Tools

AddBPATemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string

name parameter

style
string
Enum: "Tenant" "Table"

style parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "style": "Tenant"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGraphExplorerPreset

Authorizations:
bearerAuth
Request Body schema: application/json
required
action
string

action parameter

AsApp
boolean

AsApp parameter

endpoint
string

endpoint parameter

IsShared
boolean

IsShared parameter

name
string

name parameter

NoPagination
boolean

NoPagination parameter

preset
string

preset parameter

object

reportTemplate parameter

ReverseTenantLookup
boolean

ReverseTenantLookup parameter

ReverseTenantLookupProperty
string

ReverseTenantLookupProperty parameter

object

version parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "action": "string",
  • "AsApp": true,
  • "endpoint": "string",
  • "IsShared": true,
  • "name": "string",
  • "NoPagination": true,
  • "preset": "string",
  • "reportTemplate": {
    },
  • "ReverseTenantLookup": true,
  • "ReverseTenantLookupProperty": "string",
  • "version": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Conditional

AddCAPolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

CreateGroups
boolean

CreateGroups parameter

DisableSD
boolean

DisableSD parameter

NewState
string
Enum: "donotchange" "Enabled" "Disabled" "enabledForReportingButNotEnforced"

NewState parameter

overwrite
boolean

overwrite parameter

RawJSON
string

RawJSON parameter

replacename
string
Enum: "leave" "displayName" "AllUsers"

replacename parameter

object

TemplateList parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "CreateGroups": true,
  • "DisableSD": true,
  • "NewState": "donotchange",
  • "overwrite": true,
  • "RawJSON": "string",
  • "replacename": "leave",
  • "TemplateList": {
    },
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddCATemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

name
string

name parameter

object

policySource parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "policySource": {
    },
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddNamedLocation

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array of objects (LabelValue)
includeUnknownCountriesAndRegions
boolean
Ips
string
policyName
string
selectedTenants
string
Trusted
boolean
Type
string
Enum: "Countries" "IPLocation"

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Countries": [
    ],
  • "includeUnknownCountriesAndRegions": true,
  • "Ips": "string",
  • "policyName": "string",
  • "selectedTenants": "string",
  • "Trusted": true,
  • "Type": "Countries"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditCAPolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
newDisplayName
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
newDisplayName
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "newDisplayName": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCACheck

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

IpAddress
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

userID
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "authenticationFlow": {
    },
  • "ClientAppType": {
    },
  • "Country": {
    },
  • "DevicePlatform": {
    },
  • "IncludeApplications": {
    },
  • "IpAddress": "string",
  • "SignInRiskLevel": {
    },
  • "tenantFilter": "string",
  • "userID": "string",
  • "UserRiskLevel": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCAExclusion

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Formatter unwraps tenantFilter?.value || tenantFilter.

Users
Array of strings

Array of user objects from CippFormUserSelector with addedFields {userPrincipalName, displayName}. PS1 reads Users.value and Users.addedFields.userPrincipalName.

PolicyId
string

CA policy ID. Formatter unwraps autocomplete .value.

StartDate
integer

Unix timestamp (seconds) for start date/time. Formatter sends as 'StartDate' mapping form field 'startDate'.

EndDate
integer

Unix timestamp (seconds) for end date/time. Formatter sends as 'EndDate' mapping form field 'endDate'.

vacation
boolean

Always set to true by this form (vacation mode path). PS1 checks if 'vacation' == 'true' (string comparison) to determine scheduling path.

postExecution
Array of strings

Post-execution action objects. Not explicitly in this form but PS1 reads $Request.Body.postExecution.

reference
string

Not in this form but PS1 reads $Request.Body.reference.

UserID
string

Body parameter from PS1: UserID

Username
string

Body parameter from PS1: Username

ExclusionType
string

Body parameter from PS1: ExclusionType

excludeLocationAuditAlerts
string

Body parameter from PS1: excludeLocationAuditAlerts

value
string

Body parameter from PS1: value

addedFields
string

Body parameter from PS1: addedFields

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "Users": [
    ],
  • "PolicyId": "string",
  • "StartDate": 0,
  • "EndDate": 0,
  • "vacation": true,
  • "postExecution": [
    ],
  • "reference": "string",
  • "UserID": "string",
  • "Username": "string",
  • "ExclusionType": "string",
  • "excludeLocationAuditAlerts": "string",
  • "value": "string",
  • "addedFields": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCAServiceExclusion

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecNamedLocation

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

change
string
input
string
namedLocationId
string
Request Body schema: application/json
required
tenantFilter
required
string
change
string
input
string
namedLocationId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "change": "string",
  • "input": "string",
  • "namedLocationId": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCAtemplates

Authorizations:
bearerAuth
query Parameters
GUID
string

GUID parameter

ID
string

Query parameter from PS1: ID

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListConditionalAccessPolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListConditionalAccessPolicyChanges

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

displayName
string
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveCAPolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveCATemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Transport

AddConnectionFilter

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string

PowerShellCommand parameter

selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string",
  • "TemplateList": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddConnectionFilterTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddEditTransportRule

This function creates a new transport rule or edits an existing one (mail flow rule). #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

AttachmentHasExecutableContent
string
AttachmentIsPasswordProtected
string
AttachmentIsUnsupported
string
AttachmentNameMatchesPatterns
string
AttachmentProcessingLimitExceeded
string
AttachmentPropertyContainsWords
string
ExceptIfAttachmentHasExecutableContent
string
ExceptIfAttachmentIsPasswordProtected
string
ExceptIfAttachmentIsUnsupported
string
ExceptIfAttachmentNameMatchesPatterns
string
ExceptIfAttachmentProcessingLimitExceeded
string
ExceptIfAttachmentPropertyContainsWords
string
Array of objects (LabelValue)
actionType
Array of strings

actionType parameter

ActivationDate
string <date-time>

ActivationDate parameter

AnyOfCcHeader
string

AnyOfCcHeader parameter

AnyOfCcHeaderMemberOf
string

AnyOfCcHeaderMemberOf parameter

AnyOfRecipientAddressContainsWords
string

AnyOfRecipientAddressContainsWords parameter

AnyOfRecipientAddressMatchesPatterns
string

AnyOfRecipientAddressMatchesPatterns parameter

AnyOfToCcHeader
string

AnyOfToCcHeader parameter

AnyOfToCcHeaderMemberOf
string

AnyOfToCcHeaderMemberOf parameter

AnyOfToHeader
string

AnyOfToHeader parameter

AnyOfToHeaderMemberOf
string

AnyOfToHeaderMemberOf parameter

ApplyClassification
string

ApplyClassification parameter

object

ApplyHtmlDisclaimerFallbackAction parameter

object

ApplyHtmlDisclaimerLocation parameter

ApplyHtmlDisclaimerText
string

ApplyHtmlDisclaimerText parameter

ApplyOME
string

ApplyOME parameter

applyToAllMessages
boolean

applyToAllMessages parameter

AttachmentContainsWords
string

AttachmentContainsWords parameter

AttachmentExtensionMatchesWords
string

AttachmentExtensionMatchesWords parameter

AttachmentMatchesPatterns
string

AttachmentMatchesPatterns parameter

AttachmentSizeOver
string

AttachmentSizeOver parameter

BlindCopyTo
string

BlindCopyTo parameter

Comments
string

Comments parameter

conditionType
Array of strings

conditionType parameter

CopyTo
string

CopyTo parameter

DeleteMessage
string

DeleteMessage parameter

Enabled
boolean

Enabled parameter

ExceptIfAnyOfCcHeader
string

ExceptIfAnyOfCcHeader parameter

ExceptIfAnyOfCcHeaderMemberOf
string

ExceptIfAnyOfCcHeaderMemberOf parameter

ExceptIfAnyOfRecipientAddressContainsWords
string

ExceptIfAnyOfRecipientAddressContainsWords parameter

ExceptIfAnyOfRecipientAddressMatchesPatterns
string

ExceptIfAnyOfRecipientAddressMatchesPatterns parameter

ExceptIfAnyOfToCcHeader
string

ExceptIfAnyOfToCcHeader parameter

ExceptIfAnyOfToCcHeaderMemberOf
string

ExceptIfAnyOfToCcHeaderMemberOf parameter

ExceptIfAnyOfToHeader
string

ExceptIfAnyOfToHeader parameter

ExceptIfAnyOfToHeaderMemberOf
string

ExceptIfAnyOfToHeaderMemberOf parameter

ExceptIfAttachmentContainsWords
string

ExceptIfAttachmentContainsWords parameter

ExceptIfAttachmentExtensionMatchesWords
string

ExceptIfAttachmentExtensionMatchesWords parameter

ExceptIfAttachmentMatchesPatterns
string

ExceptIfAttachmentMatchesPatterns parameter

ExceptIfAttachmentSizeOver
string

ExceptIfAttachmentSizeOver parameter

ExceptIfFrom
string

ExceptIfFrom parameter

ExceptIfFromAddressContainsWords
string

ExceptIfFromAddressContainsWords parameter

ExceptIfFromAddressMatchesPatterns
string

ExceptIfFromAddressMatchesPatterns parameter

ExceptIfFromMemberOf
string

ExceptIfFromMemberOf parameter

ExceptIfFromScope
string

ExceptIfFromScope parameter

ExceptIfHeaderContainsWords
string

ExceptIfHeaderContainsWords parameter

ExceptIfHeaderContainsWordsMessageHeader
string

ExceptIfHeaderContainsWordsMessageHeader parameter

ExceptIfHeaderMatchesPatterns
string

ExceptIfHeaderMatchesPatterns parameter

ExceptIfHeaderMatchesPatternsMessageHeader
string

ExceptIfHeaderMatchesPatternsMessageHeader parameter

ExceptIfMessageSizeOver
string

ExceptIfMessageSizeOver parameter

ExceptIfMessageTypeMatches
string

ExceptIfMessageTypeMatches parameter

ExceptIfRecipientAddressContainsWords
string

ExceptIfRecipientAddressContainsWords parameter

ExceptIfRecipientAddressMatchesPatterns
string

ExceptIfRecipientAddressMatchesPatterns parameter

ExceptIfRecipientDomainIs
string

ExceptIfRecipientDomainIs parameter

ExceptIfSCLOver
string

ExceptIfSCLOver parameter

ExceptIfSenderDomainIs
string

ExceptIfSenderDomainIs parameter

ExceptIfSenderIpRanges
string

ExceptIfSenderIpRanges parameter

ExceptIfSentTo
string

ExceptIfSentTo parameter

ExceptIfSentToMemberOf
string

ExceptIfSentToMemberOf parameter

ExceptIfSentToScope
string

ExceptIfSentToScope parameter

ExceptIfSubjectContainsWords
string

ExceptIfSubjectContainsWords parameter

ExceptIfSubjectMatchesPatterns
string

ExceptIfSubjectMatchesPatterns parameter

ExceptIfSubjectOrBodyContainsWords
string

ExceptIfSubjectOrBodyContainsWords parameter

ExceptIfSubjectOrBodyMatchesPatterns
string

ExceptIfSubjectOrBodyMatchesPatterns parameter

ExceptIfWithImportance
string

ExceptIfWithImportance parameter

exceptionType
Array of strings

exceptionType parameter

ExpiryDate
string <date-time>

ExpiryDate parameter

From
string

From parameter

FromAddressContainsWords
string

FromAddressContainsWords parameter

FromAddressMatchesPatterns
string

FromAddressMatchesPatterns parameter

FromMemberOf
string

FromMemberOf parameter

FromScope
string

FromScope parameter

GenerateIncidentReport
string

GenerateIncidentReport parameter

GenerateNotification
string

GenerateNotification parameter

HeaderContainsWords
string

HeaderContainsWords parameter

HeaderContainsWordsMessageHeader
string

HeaderContainsWordsMessageHeader parameter

HeaderMatchesPatterns
string

HeaderMatchesPatterns parameter

HeaderMatchesPatternsMessageHeader
string

HeaderMatchesPatternsMessageHeader parameter

MessageSizeOver
string

MessageSizeOver parameter

MessageTypeMatches
string

MessageTypeMatches parameter

object

Mode parameter

ModerateMessageByManager
string

ModerateMessageByManager parameter

ModerateMessageByUser
string

ModerateMessageByUser parameter

Name
string

Name parameter

PrependSubject
string

PrependSubject parameter

Priority
number

Priority parameter

Quarantine
string

Quarantine parameter

RecipientAddressContainsWords
string

RecipientAddressContainsWords parameter

RecipientAddressMatchesPatterns
string

RecipientAddressMatchesPatterns parameter

RecipientDomainIs
string

RecipientDomainIs parameter

RedirectMessageTo
string

RedirectMessageTo parameter

RejectMessageEnhancedStatusCode
string

RejectMessageEnhancedStatusCode parameter

RejectMessageReasonText
string

RejectMessageReasonText parameter

RemoveHeader
string

RemoveHeader parameter

RouteMessageOutboundConnector
string

RouteMessageOutboundConnector parameter

ruleId
string

ruleId parameter

SCLOver
string

SCLOver parameter

object

SenderAddressLocation parameter

SenderDomainIs
string

SenderDomainIs parameter

SenderIpRanges
string

SenderIpRanges parameter

SentTo
string

SentTo parameter

SentToMemberOf
string

SentToMemberOf parameter

SentToScope
string

SentToScope parameter

object

SetAuditSeverity parameter

SetHeaderName
string

SetHeaderName parameter

SetHeaderValue
string

SetHeaderValue parameter

SetSCL
string

SetSCL parameter

State
string

State parameter

StopRuleProcessing
boolean

StopRuleProcessing parameter

SubjectContainsWords
string

SubjectContainsWords parameter

SubjectMatchesPatterns
string

SubjectMatchesPatterns parameter

SubjectOrBodyContainsWords
string

SubjectOrBodyContainsWords parameter

SubjectOrBodyMatchesPatterns
string

SubjectOrBodyMatchesPatterns parameter

WithImportance
string

WithImportance parameter

value
string

Body parameter from PS1: value

Count
string

Body parameter from PS1: Count

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AttachmentHasExecutableContent": "string",
  • "AttachmentIsPasswordProtected": "string",
  • "AttachmentIsUnsupported": "string",
  • "AttachmentNameMatchesPatterns": "string",
  • "AttachmentProcessingLimitExceeded": "string",
  • "AttachmentPropertyContainsWords": "string",
  • "ExceptIfAttachmentHasExecutableContent": "string",
  • "ExceptIfAttachmentIsPasswordProtected": "string",
  • "ExceptIfAttachmentIsUnsupported": "string",
  • "ExceptIfAttachmentNameMatchesPatterns": "string",
  • "ExceptIfAttachmentProcessingLimitExceeded": "string",
  • "ExceptIfAttachmentPropertyContainsWords": "string",
  • "IncidentReportContent": [
    ],
  • "actionType": [
    ],
  • "ActivationDate": "2019-08-24T14:15:22Z",
  • "AnyOfCcHeader": "string",
  • "AnyOfCcHeaderMemberOf": "string",
  • "AnyOfRecipientAddressContainsWords": "string",
  • "AnyOfRecipientAddressMatchesPatterns": "string",
  • "AnyOfToCcHeader": "string",
  • "AnyOfToCcHeaderMemberOf": "string",
  • "AnyOfToHeader": "string",
  • "AnyOfToHeaderMemberOf": "string",
  • "ApplyClassification": "string",
  • "ApplyHtmlDisclaimerFallbackAction": {
    },
  • "ApplyHtmlDisclaimerLocation": {
    },
  • "ApplyHtmlDisclaimerText": "string",
  • "ApplyOME": "string",
  • "applyToAllMessages": true,
  • "AttachmentContainsWords": "string",
  • "AttachmentExtensionMatchesWords": "string",
  • "AttachmentMatchesPatterns": "string",
  • "AttachmentSizeOver": "string",
  • "BlindCopyTo": "string",
  • "Comments": "string",
  • "conditionType": [
    ],
  • "CopyTo": "string",
  • "DeleteMessage": "string",
  • "Enabled": true,
  • "ExceptIfAnyOfCcHeader": "string",
  • "ExceptIfAnyOfCcHeaderMemberOf": "string",
  • "ExceptIfAnyOfRecipientAddressContainsWords": "string",
  • "ExceptIfAnyOfRecipientAddressMatchesPatterns": "string",
  • "ExceptIfAnyOfToCcHeader": "string",
  • "ExceptIfAnyOfToCcHeaderMemberOf": "string",
  • "ExceptIfAnyOfToHeader": "string",
  • "ExceptIfAnyOfToHeaderMemberOf": "string",
  • "ExceptIfAttachmentContainsWords": "string",
  • "ExceptIfAttachmentExtensionMatchesWords": "string",
  • "ExceptIfAttachmentMatchesPatterns": "string",
  • "ExceptIfAttachmentSizeOver": "string",
  • "ExceptIfFrom": "string",
  • "ExceptIfFromAddressContainsWords": "string",
  • "ExceptIfFromAddressMatchesPatterns": "string",
  • "ExceptIfFromMemberOf": "string",
  • "ExceptIfFromScope": "string",
  • "ExceptIfHeaderContainsWords": "string",
  • "ExceptIfHeaderContainsWordsMessageHeader": "string",
  • "ExceptIfHeaderMatchesPatterns": "string",
  • "ExceptIfHeaderMatchesPatternsMessageHeader": "string",
  • "ExceptIfMessageSizeOver": "string",
  • "ExceptIfMessageTypeMatches": "string",
  • "ExceptIfRecipientAddressContainsWords": "string",
  • "ExceptIfRecipientAddressMatchesPatterns": "string",
  • "ExceptIfRecipientDomainIs": "string",
  • "ExceptIfSCLOver": "string",
  • "ExceptIfSenderDomainIs": "string",
  • "ExceptIfSenderIpRanges": "string",
  • "ExceptIfSentTo": "string",
  • "ExceptIfSentToMemberOf": "string",
  • "ExceptIfSentToScope": "string",
  • "ExceptIfSubjectContainsWords": "string",
  • "ExceptIfSubjectMatchesPatterns": "string",
  • "ExceptIfSubjectOrBodyContainsWords": "string",
  • "ExceptIfSubjectOrBodyMatchesPatterns": "string",
  • "ExceptIfWithImportance": "string",
  • "exceptionType": [
    ],
  • "ExpiryDate": "2019-08-24T14:15:22Z",
  • "From": "string",
  • "FromAddressContainsWords": "string",
  • "FromAddressMatchesPatterns": "string",
  • "FromMemberOf": "string",
  • "FromScope": "string",
  • "GenerateIncidentReport": "string",
  • "GenerateNotification": "string",
  • "HeaderContainsWords": "string",
  • "HeaderContainsWordsMessageHeader": "string",
  • "HeaderMatchesPatterns": "string",
  • "HeaderMatchesPatternsMessageHeader": "string",
  • "MessageSizeOver": "string",
  • "MessageTypeMatches": "string",
  • "Mode": {
    },
  • "ModerateMessageByManager": "string",
  • "ModerateMessageByUser": "string",
  • "Name": "string",
  • "PrependSubject": "string",
  • "Priority": 0,
  • "Quarantine": "string",
  • "RecipientAddressContainsWords": "string",
  • "RecipientAddressMatchesPatterns": "string",
  • "RecipientDomainIs": "string",
  • "RedirectMessageTo": "string",
  • "RejectMessageEnhancedStatusCode": "string",
  • "RejectMessageReasonText": "string",
  • "RemoveHeader": "string",
  • "RouteMessageOutboundConnector": "string",
  • "ruleId": "string",
  • "SCLOver": "string",
  • "SenderAddressLocation": {
    },
  • "SenderDomainIs": "string",
  • "SenderIpRanges": "string",
  • "SentTo": "string",
  • "SentToMemberOf": "string",
  • "SentToScope": "string",
  • "SetAuditSeverity": {
    },
  • "SetHeaderName": "string",
  • "SetHeaderValue": "string",
  • "SetSCL": "string",
  • "State": "string",
  • "StopRuleProcessing": true,
  • "SubjectContainsWords": "string",
  • "SubjectMatchesPatterns": "string",
  • "SubjectOrBodyContainsWords": "string",
  • "SubjectOrBodyMatchesPatterns": "string",
  • "tenantFilter": "string",
  • "WithImportance": "string",
  • "value": "string",
  • "Count": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddExConnector

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string

PowerShellCommand parameter

selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

comment
string

Body parameter from PS1: comment

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string",
  • "TemplateList": {
    },
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddExConnectorTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
cippconnectortype
string
name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "cippconnectortype": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddTransportRule

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string

PowerShellCommand parameter

selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

PSObject
string

Body parameter from PS1: PSObject

name
string

Body parameter from PS1: name

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string",
  • "TemplateList": {
    },
  • "PSObject": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddTransportTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditExConnector

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
State
string
Type
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
State
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "State": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditTransportRule

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

guid
string
state
string
Request Body schema: application/json
required
tenantFilter
required
string
guid
string
state
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "guid": "string",
  • "state": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExConnectorTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExchangeConnectors

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTransportRules

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTransportRulesTemplates

Authorizations:
bearerAuth
query Parameters
id
string
noJson
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveExConnector

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Type
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveExConnectorTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTransportRule

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

guid
string
Request Body schema: application/json
required
tenantFilter
required
string
guid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "guid": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTransportRuleTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Administration > Contacts

AddContact

Authorizations:
bearerAuth
Request Body schema: application/json
required
Company
string

(auto) API uses 'Company', frontend sends 'companyName' — likely the same field (similarity=0.78). Verify and correct type.

Title
string

(auto) API uses 'Title', frontend sends 'jobTitle' — likely the same field (similarity=0.77). Verify and correct type.

phone
string

(auto) API uses 'phone', frontend sends 'businessPhone' — likely the same field (similarity=0.56). Verify and correct type.

displayName
string

Body parameter from PS1: displayName

State
string

Body parameter from PS1: State

tenantid
string

Body parameter from PS1: tenantid

lastName
string

Body parameter from PS1: lastName

PostalCode
string

Body parameter from PS1: PostalCode

StreetAddress
string

Body parameter from PS1: StreetAddress

mobilePhone
string

Body parameter from PS1: mobilePhone

firstName
string

Body parameter from PS1: firstName

email
string

Body parameter from PS1: email

mailTip
string

Body parameter from PS1: mailTip

website
string

Body parameter from PS1: website

City
string

Body parameter from PS1: City

hidefromGAL
string

Body parameter from PS1: hidefromGAL

CountryOrRegion
string

Body parameter from PS1: CountryOrRegion

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Company": "string",
  • "Title": "string",
  • "phone": "string",
  • "displayName": "string",
  • "State": "string",
  • "tenantid": "string",
  • "lastName": "string",
  • "PostalCode": "string",
  • "StreetAddress": "string",
  • "mobilePhone": "string",
  • "firstName": "string",
  • "email": "string",
  • "mailTip": "string",
  • "website": "string",
  • "City": "string",
  • "hidefromGAL": "string",
  • "CountryOrRegion": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddContactTemplates

Authorizations:
bearerAuth
Request Body schema: application/json
required
displayName
string

Template display name; also used as 'name' key internally

firstName
string
lastName
string
email
string
hidefromGAL
boolean

Hide from Global Address List

streetAddress
string
postalCode
string
city
string
state
string
country
string

Country code (2-letter ISO code extracted from autocomplete object by formatter)

companyName
string
mobilePhone
string
businessPhone
string
jobTitle
string
website
string
mailTip
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "hidefromGAL": true,
  • "streetAddress": "string",
  • "postalCode": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "companyName": "string",
  • "mobilePhone": "string",
  • "businessPhone": "string",
  • "jobTitle": "string",
  • "website": "string",
  • "mailTip": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

DeployContactTemplates

This function deploys contact(s) from template(s) to selected tenants. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "selectedTenants": "string",
  • "TemplateList": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditContact

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantID
string

Tenant domain/ID. Formatter reads from useSettings().currentTenant and sends as 'tenantID'.

ContactID
string

Graph contact id; read from API response. PS1 uses as Identity for Set-Contact/Set-MailContact.

displayName
string

Sent as lowercase 'displayName'; PS1 maps to 'DisplayName' parameter of Set-Contact.

hidefromGAL
boolean

PS1 uses as HiddenFromAddressListsEnabled on Set-MailContact.

email
string

PS1 maps to WindowsEmailAddress on Set-Contact.

firstName
string

PS1 maps to FirstName.

LastName
string

NOTE: formatter sends form field 'lastName' as-is but PS1 reads $contactInfo.LastName (capital L). Matches because object property access is case-insensitive in PS.

Title
string

Formatter maps form 'jobTitle' → body field 'Title'. PS1 reads $contactInfo.Title.

StreetAddress
string

Formatter maps 'streetAddress' → 'StreetAddress'. PS1 reads $contactInfo.StreetAddress.

PostalCode
string

Formatter maps 'postalCode' → 'PostalCode'.

City
string

Formatter maps 'city' → 'City'.

State
string

Formatter maps 'state' → 'State'. PS1 maps to StateOrProvince.

CountryOrRegion
string

Formatter maps 'country' autocomplete → 'CountryOrRegion' (unwraps .value).

Company
string

Formatter maps 'companyName' → 'Company'.

mobilePhone
string

PS1 maps to MobilePhone.

phone
string

Formatter maps 'businessPhone' → 'phone'. PS1 maps to Phone.

website
string

PS1 maps to WebPage.

mailTip
string

PS1 maps to MailTip on Set-MailContact.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantID": "string",
  • "ContactID": "string",
  • "displayName": "string",
  • "hidefromGAL": true,
  • "email": "string",
  • "firstName": "string",
  • "LastName": "string",
  • "Title": "string",
  • "StreetAddress": "string",
  • "PostalCode": "string",
  • "City": "string",
  • "State": "string",
  • "CountryOrRegion": "string",
  • "Company": "string",
  • "mobilePhone": "string",
  • "phone": "string",
  • "website": "string",
  • "mailTip": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditContactTemplates

Authorizations:
bearerAuth
Request Body schema: application/json
required
ContactTemplateID
string

GUID of the template to update. PS1 uses this as the RowKey filter.

displayName
string

Template display name; also used as 'name' key internally.

firstName
string
lastName
string
email
string
hidefromGAL
boolean
streetAddress
string
postalCode
string
city
string
state
string
country
string

2-letter ISO code (unwrapped from autocomplete object by formatter)

companyName
string
mobilePhone
string
businessPhone
string
jobTitle
string
website
string
mailTip
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ContactTemplateID": "string",
  • "displayName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "hidefromGAL": true,
  • "streetAddress": "string",
  • "postalCode": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "companyName": "string",
  • "mobilePhone": "string",
  • "businessPhone": "string",
  • "jobTitle": "string",
  • "website": "string",
  • "mailTip": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListContactTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListContacts

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveContact

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Mail
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
Mail
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "Mail": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveContactTemplates

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tools > Custom-Scripts

AddCustomScript

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string
AlertOnFailure
string
Category
string
Description
string
Enabled
boolean
ImplementationEffort
string
MarkdownTemplate
string
Pillar
string
RestoreToVersion
string
ResultMode
string
ResultSchema
string
ReturnType
string
Risk
string
ScriptContent
string
ScriptGuid
string
ScriptName
string
TestParameters
string
UserImpact
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AlertOnFailure": "string",
  • "Category": "string",
  • "Description": "string",
  • "Enabled": true,
  • "ImplementationEffort": "string",
  • "MarkdownTemplate": "string",
  • "Pillar": "string",
  • "RestoreToVersion": "string",
  • "ResultMode": "string",
  • "ResultSchema": "string",
  • "ReturnType": "string",
  • "Risk": "string",
  • "ScriptContent": "string",
  • "ScriptGuid": "string",
  • "ScriptName": "string",
  • "TestParameters": "string",
  • "UserImpact": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCustomScript

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
Parameters
string
ScriptGuid
string
TestParameters
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Parameters": "string",
  • "ScriptGuid": "string",
  • "TenantFilter": "string",
  • "TestParameters": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCustomScripts

Authorizations:
bearerAuth
query Parameters
IncludeAllVersions
string
ScriptGuid
string
Request Body schema: application/json
required
IncludeAllVersions
string
ScriptGuid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "IncludeAllVersions": "string",
  • "ScriptGuid": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveCustomScript

Authorizations:
bearerAuth
query Parameters
ScriptGuid
string
Request Body schema: application/json
required
ScriptGuid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Security > Compliance-DLP

AddDlpCompliancePolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string
selectedTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddDlpCompliancePolicyTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditDlpCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string
parameters
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "parameters": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDlpCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDlpCompliancePolicyTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveDlpCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveDlpCompliancePolicyTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Administration > Domains

AddDomain

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
domain
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "domain": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDomainAction

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
domain
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "domain": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Resources

AddEquipmentMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
displayName
string

displayName parameter

object

domain parameter

tenantID
string

tenantID parameter

username
string

username parameter

userPrincipalName
string

userPrincipalName parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "domain": {
    },
  • "tenantID": "string",
  • "username": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddRoomList

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

tenantid
string
username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "primDomain": {
    },
  • "tenantFilter": "string",
  • "tenantid": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddRoomMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
object

domain parameter

ResourceCapacity
string

ResourceCapacity parameter

tenantid
string

tenantid parameter

username
string

username parameter

userPrincipalName
string

userPrincipalName parameter

DisplayName
string

Body parameter from PS1: DisplayName

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "domain": {
    },
  • "ResourceCapacity": "string",
  • "tenantid": "string",
  • "username": "string",
  • "userPrincipalName": "string",
  • "DisplayName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditEquipmentMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantID
string

Tenant domain. Formatter reads from useSettings().currentTenant.

equipmentId
string

Equipment mailbox identity (from router query). PS1 uses for Set-Mailbox, Set-User, Set-CalendarProcessing, Set-MailboxCalendarConfiguration Identity.

hiddenFromAddressListsEnabled
boolean
department
string
company
string
streetAddress
string

PS1 Set-User param name is 'StreetAddress' but reads $MailboxObject.streetAddress (case-insensitive)

city
string
stateOrProvince
string
postalCode
string
countryOrRegion
string

2-letter country code; formatter unwraps autocomplete .value

phone
string
tags
Array of strings

Array of strings; formatter maps tag objects to .value strings

allowConflicts
boolean
allowRecurringMeetings
boolean
bookingWindowInDays
integer
maximumDurationInMinutes
integer
processExternalMeetingMessages
boolean
forwardRequestsToDelegates
boolean
scheduleOnlyDuringWorkHours
boolean
automateProcessing
string

Enum: None|AutoUpdate|AutoAccept. Formatter unwraps autocomplete .value.

workDays
string

Comma-separated string of work days. Formatter joins array of {value} objects.

workHoursStartTime
string
workHoursEndTime
string
workingHoursTimeZone
string

Timezone standard name. Formatter unwraps autocomplete .value.

userPrincipalName
string

Body parameter from PS1: userPrincipalName

DisplayName
string

Body parameter from PS1: DisplayName

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantID": "string",
  • "equipmentId": "string",
  • "hiddenFromAddressListsEnabled": true,
  • "department": "string",
  • "company": "string",
  • "streetAddress": "string",
  • "city": "string",
  • "stateOrProvince": "string",
  • "postalCode": "string",
  • "countryOrRegion": "string",
  • "phone": "string",
  • "tags": [
    ],
  • "allowConflicts": true,
  • "allowRecurringMeetings": true,
  • "bookingWindowInDays": 0,
  • "maximumDurationInMinutes": 0,
  • "processExternalMeetingMessages": true,
  • "forwardRequestsToDelegates": true,
  • "scheduleOnlyDuringWorkHours": true,
  • "automateProcessing": "string",
  • "workDays": "string",
  • "workHoursStartTime": "string",
  • "workHoursEndTime": "string",
  • "workingHoursTimeZone": "string",
  • "userPrincipalName": "string",
  • "DisplayName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditRoomList

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
groupId
string

Room list group ID (Guid or id). PS1 reads $RoomListObj.groupId.

displayName
string
description
string
mailNickname
string

PS1 passes as 'Name' to Set-DistributionGroup.

AddMember
Array of strings

Array of room email addresses (strings or {value: email} objects) to add.

RemoveMember
Array of strings

Array of room email addresses or objects to remove.

AddOwner
Array of strings

Array of user objects [{value: UPN, addedFields: {id}}] to add as owners.

RemoveOwner
Array of strings

Array of user objects [{value: UPN, addedFields: {id}}] to remove from owners.

allowExternal
boolean

Only sent if changed from original value (formatter deletes it if unchanged).

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "groupId": "string",
  • "displayName": "string",
  • "description": "string",
  • "mailNickname": "string",
  • "AddMember": [
    ],
  • "RemoveMember": [
    ],
  • "AddOwner": [
    ],
  • "RemoveOwner": [
    ],
  • "allowExternal": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditRoomMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantID
string

Tenant domain. Formatter reads from useSettings().currentTenant.

roomId
string

Room mailbox identity (from router query). PS1 uses for all cmdlet Identity fields.

hiddenFromAddressListsEnabled
boolean
capacity
integer

PS1 passes as ResourceCapacity to Set-Mailbox.

building
string
floor
integer
floorLabel
string
street
string

PS1 passes to Set-Place as 'Street'.

city
string
state
string
postalCode
string
countryOrRegion
string

2-letter country code; formatter unwraps autocomplete .value.

audioDeviceName
string
videoDeviceName
string
displayDeviceName
string
isWheelChairAccessible
boolean
phone
string
tags
Array of strings

Array of strings; formatter maps {label,value} objects to .value strings.

AllowConflicts
boolean
AllowRecurringMeetings
boolean
BookingWindowInDays
integer
MaximumDurationInMinutes
integer
ProcessExternalMeetingMessages
boolean
EnforceCapacity
boolean
ForwardRequestsToDelegates
boolean
ScheduleOnlyDuringWorkHours
boolean
AutomateProcessing
string

Enum: None|AutoUpdate|AutoAccept. Formatter unwraps autocomplete .value.

AddOrganizerToSubject
boolean
DeleteSubject
boolean
RemoveCanceledMeetings
boolean
WorkDays
string

Comma-separated string of work days. Formatter joins array of {value} objects.

WorkHoursStartTime
string
WorkHoursEndTime
string
WorkingHoursTimeZone
string

Timezone standard name. Formatter unwraps autocomplete .value.

userPrincipalName
string

Body parameter from PS1: userPrincipalName

DisplayName
string

Body parameter from PS1: DisplayName

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantID": "string",
  • "roomId": "string",
  • "hiddenFromAddressListsEnabled": true,
  • "capacity": 0,
  • "building": "string",
  • "floor": 0,
  • "floorLabel": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "countryOrRegion": "string",
  • "audioDeviceName": "string",
  • "videoDeviceName": "string",
  • "displayDeviceName": "string",
  • "isWheelChairAccessible": true,
  • "phone": "string",
  • "tags": [
    ],
  • "AllowConflicts": true,
  • "AllowRecurringMeetings": true,
  • "BookingWindowInDays": 0,
  • "MaximumDurationInMinutes": 0,
  • "ProcessExternalMeetingMessages": true,
  • "EnforceCapacity": true,
  • "ForwardRequestsToDelegates": true,
  • "ScheduleOnlyDuringWorkHours": true,
  • "AutomateProcessing": "string",
  • "AddOrganizerToSubject": true,
  • "DeleteSubject": true,
  • "RemoveCanceledMeetings": true,
  • "WorkDays": "string",
  • "WorkHoursStartTime": "string",
  • "WorkHoursEndTime": "string",
  • "WorkingHoursTimeZone": "string",
  • "userPrincipalName": "string",
  • "DisplayName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListEquipment

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

EquipmentId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRoomLists

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

groupID
string
members
string
owners
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRooms

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

roomId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Identity > Administration > Groups

AddGroup

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

(auto) from API scan

membershipRules
string

(auto) from CippAddGroupForm.jsx

displayName
string

(auto) from CippAddGroupForm.jsx

description
string

(auto) from CippAddGroupForm.jsx

username
string

(auto) from CippAddGroupForm.jsx

groupType
string
Enum: "azurerole" "generic" "m365" "dynamic" "dynamicdistribution" "distribution" "security"

(auto) from CippAddGroupForm.jsx

allowExternal
boolean

(auto) from CippAddGroupForm.jsx

subscribeMembers
boolean

(auto) from CippAddGroupForm.jsx

object

(auto) from CippAddGroupForm.jsx

owners
Array of strings

(auto) from CippAddGroupForm.jsx (array of LabelValue)

members
Array of strings

(auto) from CippAddGroupForm.jsx (array of LabelValue)

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "membershipRules": "string",
  • "displayName": "string",
  • "description": "string",
  • "username": "string",
  • "groupType": "azurerole",
  • "allowExternal": true,
  • "subscribeMembers": true,
  • "primDomain": {
    },
  • "owners": [
    ],
  • "members": [
    ],
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddGroupTeam

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
GroupId
string
TeamSettings
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GroupId": "string",
  • "TeamSettings": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddGroupTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
GUID
string

(auto) from CippAddGroupTemplateForm.jsx

username
string

(auto) from CippAddGroupTemplateForm.jsx

groupType
string
Enum: "azurerole" "generic" "m365" "dynamic" "dynamicDistribution" "distribution" "security"

(auto) from CippAddGroupTemplateForm.jsx

allowExternal
boolean

(auto) from CippAddGroupTemplateForm.jsx

subscribeMembers
boolean

(auto) from CippAddGroupTemplateForm.jsx

membershipRules
string

(auto) from CippAddGroupTemplateForm.jsx

displayname
string

Body parameter from PS1: displayname

Description
string

Body parameter from PS1: Description

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "username": "string",
  • "groupType": "azurerole",
  • "allowExternal": true,
  • "subscribeMembers": true,
  • "membershipRules": "string",
  • "displayname": "string",
  • "Description": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditGroup

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Tenant domain. PS1 reads $UserObj.tenantFilter and falls back to $UserObj.tenantId.

object

Group ID string. PS1 reads $UserObj.groupId.value ?? $UserObj.groupId.

groupType
string

Group type string e.g. 'Microsoft 365', 'Security', 'Distribution List', 'Mail-Enabled Security'. PS1 reads $UserObj.groupId.addedFields.groupType ?? $UserObj.groupType.

displayName
string

New display name. PS1 reads as groupName ?? displayName ?? groupId.addedFields.groupName.

description
string
mailNickname
string
membershipRules
string

Dynamic membership rule expression. Only used for DynamicMembership groups.

securityEnabled
boolean

Only sent if changed from initial value (customDataformatter deletes unchanged properties).

visibility
string

'Public'|'Private'. Only sent if changed from initial value.

allowExternal
boolean

Allow external senders. Only sent if changed.

sendCopies
boolean

Send copies to member inboxes (M365 groups). Only sent if changed.

hideFromOutlookClients
boolean

Hide group from Outlook (M365 groups). Only sent if changed.

mail
string

Group email address; used for ExO DL operations.

AddMember
Array of strings

Array of user objects to add as members [{value: id, addedFields: {userPrincipalName, displayName, id}}].

RemoveMember
Array of strings

Array of user objects to remove [{value: id, addedFields: {userPrincipalName}}].

AddOwner
Array of strings

Array of user objects to add as owners.

RemoveOwner
Array of strings

Array of user objects to remove from owners.

AddContact
Array of strings

Array of contact objects to add [{value: email/guid, addedFields: {id, displayName, WindowsEmailAddress}}].

RemoveContact
Array of strings

Array of contact objects to remove [{value: mail/guid, addedFields: {id}}].

groupName
string

Body parameter from PS1: groupName

tenantId
string

Body parameter from PS1: tenantId

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "groupId": {
    },
  • "groupType": "string",
  • "displayName": "string",
  • "description": "string",
  • "mailNickname": "string",
  • "membershipRules": "string",
  • "securityEnabled": true,
  • "visibility": "string",
  • "allowExternal": true,
  • "sendCopies": true,
  • "hideFromOutlookClients": true,
  • "mail": "string",
  • "AddMember": [
    ],
  • "RemoveMember": [
    ],
  • "AddOwner": [
    ],
  • "RemoveOwner": [
    ],
  • "AddContact": [
    ],
  • "RemoveContact": [
    ],
  • "groupName": "string",
  • "tenantId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGroupSenderAuthentication

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

groupid
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGroupTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGroups

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

expandMembers
string
groupID
string
groupType
string
members
string
owners
string
UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveGroupTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Identity > Administration > Users

AddGuest

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

object
bulkGuests
string

bulkGuests parameter

displayName
string

displayName parameter

mail
string

mail parameter

message
string

message parameter

redirectUri
string

redirectUri parameter

sendInvite
boolean

sendInvite parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "addrow": {
    },
  • "bulkGuests": "string",
  • "displayName": "string",
  • "mail": "string",
  • "message": "string",
  • "redirectUri": "string",
  • "sendInvite": true,
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddJITAdminTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain or GUID, or "AllTenants" to create a global template. "AllTenants" templates cannot use defaultUserAction="select".

defaultUseGroups
boolean
defaultUseRoles
boolean
object

Pre-selects a domain when userAction is "create". LabelValue shape: { "label": "contoso.com", "value": "contoso.com" }. The value is the domain string. Accepts a plain string.

object

Default JIT access duration. LabelValue shape: { "label": "4 Hours", "value": "PT4H" }. The value must be an ISO 8601 duration string. Common presets: "PT1H" (1 hr), "PT4H" (4 hrs), "PT8H" (8 hrs), "P1D" (1 day), "P3D", "P7D", "P14D", "P30D". Custom durations like "PT2H30M" are also valid. Cannot exceed the global MaxDuration set in JIT Admin Settings.

object

Pre-selects a user when defaultUserAction is "select". LabelValue shape: { "label": "User Display Name", "value": "" }. The PS1 accepts either a UPN or an ObjectId GUID as the value.

object

Default expiration action for JIT sessions using this template. LabelValue shape: { "label": "...", "value": "" }. Valid values: "DisableUser", "DeleteUser", "RemoveRoles" (select only), "RemoveGroups" (select only), "RemoveRolesAndGroups" (select only). The "Remove*" variants require defaultUserAction="select".

defaultFirstName
string

Pre-fills the first name field when defaultUserAction is "create".

defaultForTenant
boolean

If true, marks this template as the default for the target tenant. Only one template can be the tenant default.

object

Array of groups pre-selected in the template. LabelValue shape: { "label": "Group Display Name", "value": "" }. The value must be the group's ObjectId (GUID). Stored as-is and applied when a JIT session is created from this template.

defaultLastName
string

Pre-fills the last name field when defaultUserAction is "create".

defaultNotificationActions
Array of strings

Default notification actions for JIT sessions created from this template. Array of strings. Valid values: "Webhook", "email", "PSA".

object

Array of admin roles pre-selected in the template. LabelValue shape: { "label": "Role Display Name", "value": "" }. The value must be the role's ObjectId (GUID). Retrieve available roles from GET /api/ListRoles?TenantFilter=. Stored as-is and applied when a JIT session is created from this template.

defaultUserAction
string
Enum: "create" "select"

Whether sessions created from this template target a new or existing user. Valid values: "create" (new user), "select" (existing user). When set to "AllTenants", only "create" is permitted.

object

Default usage location for new users created from this template. LabelValue shape: { "label": "Canada", "value": "CA" }. The value must be an ISO 3166-1 alpha-2 country code. Accepts a plain country code string. PS1 unwraps .value with fallback to the raw string.

defaultUserName
string

Pre-fills the username prefix field when defaultUserAction is "create".

generateTAPByDefault
boolean

If true, JIT sessions created from this template will generate a Temporary Access Pass instead of a password. Only applies when defaultUserAction="create".

reasonTemplate
string

Default reason/justification text pre-filled when creating a JIT session from this template.

templateName
string

Unique name for this template within the target tenant. Required.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "defaultUseGroups": true,
  • "defaultUseRoles": true,
  • "defaultDomain": {
    },
  • "defaultDuration": {
    },
  • "defaultExistingUser": {
    },
  • "defaultExpireAction": {
    },
  • "defaultFirstName": "string",
  • "defaultForTenant": true,
  • "defaultGroups": {
    },
  • "defaultLastName": "string",
  • "defaultNotificationActions": [
    ],
  • "defaultRoles": {
    },
  • "defaultUserAction": "create",
  • "defaultUsageLocation": {
    },
  • "defaultUserName": "string",
  • "generateTAPByDefault": true,
  • "reasonTemplate": "string",
  • "templateName": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddUser

Create a new user in a tenant, optionally scheduled

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain

givenName
string
surname
string
username
string

UPN prefix (before the @)

password
string

Initial password. Omit to auto-generate.

MustChangePass
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

licenses
Array of strings

SKU IDs to assign

jobTitle
string
department
string
streetAddress
string
city
string
state
string
postalCode
string
country
string
companyName
string
mobilePhone
string
businessPhones
Array of strings
object

Copy group memberships from this user

object

Apply a saved user template

object (ScheduledTask)

Controls deferred execution. If Enabled is true, task is queued rather than run immediately.

reference
string

External reference ID (PSA ticket, etc.)

PostExecution
string

Body parameter from PS1: PostExecution

mailNickname
string

Body parameter from PS1: mailNickname

object

Body parameter from PS1: PrimDomain

DisplayName
string

Body parameter from PS1: DisplayName

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "givenName": "string",
  • "surname": "string",
  • "username": "string",
  • "password": "string",
  • "MustChangePass": true,
  • "usageLocation": {
    },
  • "licenses": [
    ],
  • "jobTitle": "string",
  • "department": "string",
  • "streetAddress": "string",
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "companyName": "string",
  • "mobilePhone": "string",
  • "businessPhones": [
    ],
  • "copyFrom": {
    },
  • "userTemplate": {
    },
  • "Scheduled": {
    },
  • "reference": "string",
  • "PostExecution": "string",
  • "mailNickname": "string",
  • "PrimDomain": {
    },
  • "DisplayName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Bulk-create users in a tenant via CSV import

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain

BulkUser
Array of strings

Array of user objects to create. Each element is a user row (typically from CSV import).

licenses
Array of strings

License SKU IDs to assign to all created users. Accepts array of GUID strings or LabelValue objects.

object

Usage location applied to all created users. Accepts LabelValue or raw ISO country code string.

value
string

Body parameter from PS1: value

label
string

Body parameter from PS1: label

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "BulkUser": [
    ],
  • "licenses": [
    ],
  • "usageLocation": {
    },
  • "value": "string",
  • "label": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddUserDefaults

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
addedAliases
string

Additional SMTP aliases, newline-delimited (server splits on \n)

Array of objects (GroupRef)
businessPhones
Array of strings
city
string
companyName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

country
string
defaultForTenant
string
department
string
displayName
string
givenName
string
groupMemberships
string
GUID
string
jobTitle
string
licenses
Array of strings

License SKU IDs to assign

mobilePhone
string
MustChangePass
boolean
otherMails
Array of strings
password
string
postalCode
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

removeLicenses
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

state
string
streetAddress
string
surname
string
templateName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

usernameFormat
string
usernameSpaceHandling
string
usernameSpaceReplacement
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "addedAliases": "string",
  • "addToGroups": [
    ],
  • "businessPhones": [
    ],
  • "city": "string",
  • "companyName": "string",
  • "copyFrom": {
    },
  • "country": "string",
  • "defaultForTenant": "string",
  • "department": "string",
  • "displayName": "string",
  • "givenName": "string",
  • "groupMemberships": "string",
  • "GUID": "string",
  • "jobTitle": "string",
  • "licenses": [
    ],
  • "mobilePhone": "string",
  • "MustChangePass": true,
  • "otherMails": [
    ],
  • "password": "string",
  • "postalCode": "string",
  • "primDomain": {
    },
  • "removeLicenses": true,
  • "setManager": {
    },
  • "setSponsor": {
    },
  • "state": "string",
  • "streetAddress": "string",
  • "surname": "string",
  • "templateName": "string",
  • "tenantFilter": "string",
  • "usageLocation": {
    },
  • "usernameFormat": "string",
  • "usernameSpaceHandling": "string",
  • "usernameSpaceReplacement": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditJITAdminTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain or GUID, or "AllTenants" for a global template. "AllTenants" templates cannot use defaultUserAction="select".

defaultUseGroups
boolean
defaultUseRoles
boolean
GUID
string

GUID of the template to edit. Retrieve from GET /api/ListJITAdminTemplates.

object

Pre-selects a domain when userAction is "create". LabelValue shape: { "label": "contoso.com", "value": "contoso.com" }. The value is the domain string. Accepts a plain string.

object

Default JIT access duration. LabelValue shape: { "label": "4 Hours", "value": "PT4H" }. The value must be an ISO 8601 duration string. Common presets: "PT1H" (1 hr), "PT4H" (4 hrs), "PT8H" (8 hrs), "P1D" (1 day), "P3D", "P7D", "P14D", "P30D". Custom durations like "PT2H30M" are also valid. Cannot exceed the global MaxDuration set in JIT Admin Settings.

object

Pre-selects a user when defaultUserAction is "select". LabelValue shape: { "label": "User Display Name", "value": "" }. The PS1 accepts either a UPN or an ObjectId GUID as the value.

object

Default expiration action for JIT sessions using this template. LabelValue shape: { "label": "...", "value": "" }. Valid values: "DisableUser", "DeleteUser", "RemoveRoles" (select only), "RemoveGroups" (select only), "RemoveRolesAndGroups" (select only). The "Remove*" variants require defaultUserAction="select".

defaultFirstName
string

Pre-fills the first name field when defaultUserAction is "create".

defaultForTenant
boolean

If true, marks this template as the default for the target tenant. Only one template can be the tenant default.

object

Array of groups pre-selected in the template. LabelValue shape: { "label": "Group Display Name", "value": "" }. The value must be the group's ObjectId (GUID). Stored as-is and applied when a JIT session is created from this template.

defaultLastName
string

Pre-fills the last name field when defaultUserAction is "create".

defaultNotificationActions
Array of strings

Default notification actions for JIT sessions created from this template. Array of strings. Valid values: "Webhook", "email", "PSA".

object

Array of admin roles pre-selected in the template. LabelValue shape: { "label": "Role Display Name", "value": "" }. The value must be the role's ObjectId (GUID). Retrieve available roles from GET /api/ListRoles?TenantFilter=. Stored as-is and applied when a JIT session is created from this template.

defaultUserAction
string
Enum: "create" "select"

Whether sessions created from this template target a new or existing user. Valid values: "create" (new user), "select" (existing user). When tenantFilter is "AllTenants", only "create" is permitted.

object

Default usage location for new users created from this template. LabelValue shape: { "label": "Canada", "value": "CA" }. The value must be an ISO 3166-1 alpha-2 country code. Accepts a plain country code string. PS1 unwraps .value with fallback to the raw string.

defaultUserName
string

Pre-fills the username prefix field when defaultUserAction is "create".

generateTAPByDefault
boolean

If true, JIT sessions created from this template will generate a Temporary Access Pass instead of a password. Only applies when defaultUserAction="create".

reasonTemplate
string

Default reason/justification text pre-filled when creating a JIT session from this template.

templateName
string

Unique name for this template within the target tenant. Required.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "defaultUseGroups": true,
  • "defaultUseRoles": true,
  • "GUID": "string",
  • "defaultDomain": {
    },
  • "defaultDuration": {
    },
  • "defaultExistingUser": {
    },
  • "defaultExpireAction": {
    },
  • "defaultFirstName": "string",
  • "defaultForTenant": true,
  • "defaultGroups": {
    },
  • "defaultLastName": "string",
  • "defaultNotificationActions": [
    ],
  • "defaultRoles": {
    },
  • "defaultUserAction": "create",
  • "defaultUsageLocation": {
    },
  • "defaultUserName": "string",
  • "generateTAPByDefault": true,
  • "reasonTemplate": "string",
  • "templateName": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditUser

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

(auto) from API scan

object

(auto) from CippAddEditUser.jsx

givenName
string

(auto) from CippAddEditUser.jsx

surname
string

(auto) from CippAddEditUser.jsx

Autopassword
boolean

(auto) from CippAddEditUser.jsx

password
string <password>

(auto) from CippAddEditUser.jsx

MustChangePass
boolean

(auto) from CippAddEditUser.jsx

object

(auto) from CippAddEditUser.jsx

sherweb
boolean

(auto) from CippAddEditUser.jsx

removeLicenses
boolean

(auto) from CippAddEditUser.jsx

jobTitle
string

(auto) from CippAddEditUser.jsx

streetAddress
string

(auto) from CippAddEditUser.jsx

city
string

(auto) from CippAddEditUser.jsx

state
string

(auto) from CippAddEditUser.jsx

postalCode
string

(auto) from CippAddEditUser.jsx

country
string

(auto) from CippAddEditUser.jsx

companyName
string

(auto) from CippAddEditUser.jsx

department
string

(auto) from CippAddEditUser.jsx

mobilePhone
string

(auto) from CippAddEditUser.jsx

businessPhones
string

(auto) from CippAddEditUser.jsx

otherMails
string

(auto) from CippAddEditUser.jsx

AddToGroups
Array of strings

(auto) from CippAddEditUser.jsx (array of LabelValue)

RemoveFromGroups
Array of strings

(auto) from CippAddEditUser.jsx (array of LabelValue)

object
object
reference
string

(auto) from CippAddEditUser.jsx

object

(auto) from CippAddEditUser.jsx

licenses
Array of strings

(auto) from CippAddEditUser.jsx

object

(auto) from CippAddEditUser.jsx

object

(auto) from CippAddEditUser.jsx

PostExecution
string

(auto) from API scan

id
string

(auto) from API scan

username
string

(auto) from API scan

Domain
string

(auto) from API scan

mailNickname
string

(auto) from API scan

defaultAttributes
string

(auto) from API scan

customData
string

(auto) from API scan

object

(auto) from API scan

userPrincipalName
string

(auto) from API scan

CopyFrom
string

Body parameter from PS1: CopyFrom

DisplayName
string

Body parameter from PS1: DisplayName

AddedAliases
string

Body parameter from PS1: AddedAliases

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "userTemplate": {
    },
  • "givenName": "string",
  • "surname": "string",
  • "Autopassword": true,
  • "password": "pa$$word",
  • "MustChangePass": true,
  • "usageLocation": {
    },
  • "sherweb": true,
  • "removeLicenses": true,
  • "jobTitle": "string",
  • "streetAddress": "string",
  • "city": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "companyName": "string",
  • "department": "string",
  • "mobilePhone": "string",
  • "businessPhones": "string",
  • "otherMails": "string",
  • "AddToGroups": [
    ],
  • "RemoveFromGroups": [
    ],
  • "Scheduled": {
    },
  • "postExecution": {
    },
  • "reference": "string",
  • "primDomain": {
    },
  • "licenses": [
    ],
  • "setManager": {
    },
  • "setSponsor": {
    },
  • "PostExecution": "string",
  • "id": "string",
  • "username": "string",
  • "Domain": "string",
  • "mailNickname": "string",
  • "defaultAttributes": "string",
  • "customData": "string",
  • "tenantFilter": "string",
  • "sherwebLicense": {
    },
  • "userPrincipalName": "string",
  • "CopyFrom": "string",
  • "DisplayName": "string",
  • "AddedAliases": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditUserAliases

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

AddedAliases
string

AddedAliases parameter

id
string

id parameter

MakePrimary
string

MakePrimary parameter

RemovedAliases
string

RemovedAliases parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AddedAliases": "string",
  • "id": "string",
  • "MakePrimary": "string",
  • "RemovedAliases": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBECCheck

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
overwrite
string
userid
string
userName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBECRemediate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
userid
string
username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "userid": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBulkLicense

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecClrImmId

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCreateTAP

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
isUsableOnce
string
lifetimeInMinutes
string
startDateTime
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
isUsableOnce
string
lifetimeInMinutes
string
startDateTime
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "isUsableOnce": "string",
  • "lifetimeInMinutes": "string",
  • "startDateTime": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDisableUser

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Enable
string
ID
string
Request Body schema: application/json
required
tenantFilter
required
string
Enable
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Enable": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDismissRiskyUser

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

userDisplayName
string
userId
string
Request Body schema: application/json
required
tenantFilter
required
string
userDisplayName
string
userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "userDisplayName": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecJITAdmin

Just-in-time admin management API endpoint. This function can create users, add roles, remove roles, delete, or disable a user. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain or GUID. Required.

useGroups
boolean
useRoles
boolean
object

Array of admin roles to assign. LabelValue shape: { "label": "Role Display Name", "value": "" }. The value must be the role's ObjectId (GUID). Retrieve available roles from GET /api/ListRoles?TenantFilter=.

object

Domain for the new user's UPN. Required when userAction="create". Accepts a LabelValue object ({ "label": "contoso.com", "value": "contoso.com" }) or a plain domain string. PS1 unwraps .value with fallback to the raw string.

EndDate
string <date-time>

Unix timestamp (seconds) for when the JIT access expires. The scheduler removes/disables the user at this time per ExpireAction.

object

Target user when userAction="select". LabelValue shape: { "label": "User Display Name", "value": "" }. If value is a GUID (ObjectId), the PS1 resolves it to a UPN automatically via Graph. Required when userAction="select".

object

Action to perform when JIT access expires. LabelValue shape: { "label": "...", "value": "" }. Valid values: "DisableUser" (disable the account), "DeleteUser" (permanently delete), "RemoveRoles" (userAction=select only), "RemoveGroups" (userAction=select only), "RemoveRolesAndGroups" (userAction=select only). Accepts a plain string instead of a LabelValue object.

FirstName
string

First name for the new user. Required when userAction="create".

object

Array of groups to add the user to. LabelValue shape: { "label": "Group Display Name", "value": "" }. The value must be the group's ObjectId (GUID). Used when ExpireAction includes group removal.

object

Template to pre-populate defaults from. LabelValue shape: { "label": "Template Name", "value": "" }. Retrieve available templates from GET /api/ListJITAdminTemplates?TenantFilter=.

LastName
string

Last name for the new user. Required when userAction="create".

PostExecution
Array of strings

Notification actions to trigger after JIT access is granted. Array of strings. Valid values: "Webhook", "email", "PSA".

reason
string

Justification text for why JIT access is being granted. Stored on the JIT admin record.

StartDate
string <date-time>

Unix timestamp (seconds) for when JIT access begins. Defaults to immediate if omitted.

tapLifetimeInMinutes
string

Lifetime of the Temporary Access Pass in minutes. Only used when UseTAP=true. Must be within the tenant's TAP policy limits. Omit to use the tenant default.

userAction
string
Enum: "create" "select"

Whether to create a new user or target an existing one. "create" requires FirstName, LastName, username, Domain. "select" requires existingUser.

object

Usage location for the new user (required by Microsoft for license assignment). LabelValue shape: { "label": "Country Name", "value": "<ISO 3166-1 alpha-2 code>" } — e.g. { "label": "Canada", "value": "CA" }. Accepts a plain country code string. Only used when userAction="create".

username
string

Username prefix (without domain) for the new user. Combined with Domain to form the UPN. Required when userAction="create".

UseTAP
boolean

If true, generates a Temporary Access Pass instead of a password for the new user. Only applicable when userAction="create".

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "useGroups": true,
  • "useRoles": true,
  • "AdminRoles": {
    },
  • "Domain": {
    },
  • "EndDate": "2019-08-24T14:15:22Z",
  • "existingUser": {
    },
  • "ExpireAction": {
    },
  • "FirstName": "string",
  • "GroupMemberships": {
    },
  • "jitAdminTemplate": {
    },
  • "LastName": "string",
  • "PostExecution": [
    ],
  • "reason": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "tapLifetimeInMinutes": "string",
  • "tenantFilter": "string",
  • "userAction": "create",
  • "usageLocation": {
    },
  • "username": "string",
  • "UseTAP": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOffboardUser

Offboard a user with configurable options for mailbox conversion, access delegation, license removal, and more

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Target tenant domain

user
Array of strings

Array of user principal names to offboard

ConvertToShared
boolean

Convert user mailbox to shared mailbox

HideFromGAL
boolean

Hide mailbox from Global Address List

removeCalendarInvites
boolean

Remove calendar invites for the user

removePermissions
boolean

Remove mailbox permissions granted to the user

removeCalendarPermissions
boolean

Remove calendar permissions granted to the user

RemoveRules
boolean

Remove mailbox rules

RemoveMobile
boolean

Remove mobile device associations

RemoveGroups
boolean

Remove user from all groups

RemoveLicenses
boolean

Remove all licenses from the user

RevokeSessions
boolean

Revoke all active sessions

DisableSignIn
boolean

Disable user sign-in

ClearImmutableId
boolean

Clear the ImmutableId (on-premises sync attribute)

ResetPass
boolean

Reset user password

RemoveMFADevices
boolean

Remove all MFA devices

RemoveTeamsPhoneDID
boolean

Remove Teams phone number assignment

DeleteUser
boolean

Permanently delete the user account

object

Grant mailbox access without automapping (user selection)

object

Grant mailbox access with automapping (user selection)

object

Grant OneDrive access (user selection)

forward
string

Email address to forward mail to

disableForwarding
boolean

Disable mail forwarding

KeepCopy
boolean

Keep copy of forwarded messages in mailbox

OOO
string

Out of office message

object

Schedule offboarding for a future time

object

Post-execution notifications

reference
string

Reference identifier for tracking

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "user": [
    ],
  • "ConvertToShared": true,
  • "HideFromGAL": true,
  • "removeCalendarInvites": true,
  • "removePermissions": true,
  • "removeCalendarPermissions": true,
  • "RemoveRules": true,
  • "RemoveMobile": true,
  • "RemoveGroups": true,
  • "RemoveLicenses": true,
  • "RevokeSessions": true,
  • "DisableSignIn": true,
  • "ClearImmutableId": true,
  • "ResetPass": true,
  • "RemoveMFADevices": true,
  • "RemoveTeamsPhoneDID": true,
  • "DeleteUser": true,
  • "AccessNoAutomap": {
    },
  • "AccessAutomap": {
    },
  • "OnedriveAccess": {
    },
  • "forward": "string",
  • "disableForwarding": true,
  • "KeepCopy": true,
  • "OOO": "string",
  • "Scheduled": {
    },
  • "PostExecution": {
    },
  • "reference": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOneDriveShortCut

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
siteUrl
string
userid
string
username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "siteUrl": "string",
  • "tenantFilter": "string",
  • "userid": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOnedriveProvision

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserPrincipalName
string
Request Body schema: application/json
required
tenantFilter
required
string
UserPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "UserPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecPasswordNeverExpires

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
PasswordPolicy
string
userId
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PasswordPolicy": "string",
  • "tenantFilter": "string",
  • "userId": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecPerUserMFA

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
State
string
userId
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "State": "string",
  • "tenantFilter": "string",
  • "userId": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecReprocessUserLicenses

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
userPrincipalName
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecResetMFA

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecResetPass

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

displayName
string
ID
string
MustChange
string
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
ID
string
MustChange
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "ID": "string",
  • "MustChange": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRestoreDeleted

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
ID
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "ID": "string",
  • "tenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRevokeSessions

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

id
string
Username
string
Request Body schema: application/json
required
tenantFilter
required
string
id
string
Username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSendPush

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
UserEmail
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "TenantFilter": "string",
  • "UserEmail": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetUserPhoto

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

action
string
userId
string
Request Body schema: application/json
required
tenantFilter
required
string
action
string
photoData
string
userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "action": "string",
  • "photoData": "string",
  • "tenantFilter": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDeletedItems

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListJITAdmin

List Just-in-time admin users for a tenant or all tenants. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListJITAdminTemplates

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
includeAllTenants
string
Request Body schema: application/json
required
includeAllTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListNewUserDefaults

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
includeAllTenants
string
Request Body schema: application/json
required
includeAllTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListPerUserMFA

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

allUsers
string
userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserConditionalAccessPolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserCounts

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserGroups

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserMailboxDetails

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string
userMail
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserMailboxRules

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

userEmail
string
UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserPhoto

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserSettings

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserSigninLogs

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

top
string
UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUserTrustedBlockedSenders

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUsers

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

graphFilter
string

OData $filter expression passed to Graph

IncludeLogonDetails
string
UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

PatchUser

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
Array
tenantFilter
required
string

Required field on each array element (validated in handler).

id
string
manager
string

Required field on each array element (validated in handler).

sponsor
string

Required field on each array element (validated in handler).

property name*
additional property
any

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "id": "string",
  • "manager": "string",
  • "sponsor": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveDeletedObject

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
ID
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "ID": "string",
  • "tenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveJITAdminTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTrustedBlockedSender

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
typeProperty
string
userPrincipalName
string
value
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "typeProperty": "string",
  • "userPrincipalName": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveUser

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
userPrincipalName
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveUserDefaultTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Spamfilter

AddQuarantinePolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
AllowSender
boolean

AllowSender parameter

BlockSender
boolean

BlockSender parameter

Delete
boolean

Delete parameter

IncludeMessagesFromBlockedSenderAddress
boolean

IncludeMessagesFromBlockedSenderAddress parameter

Name
string

Name parameter

Preview
boolean

Preview parameter

QuarantineNotification
boolean

QuarantineNotification parameter

object

ReleaseActionPreference parameter

selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AllowSender": true,
  • "BlockSender": true,
  • "Delete": true,
  • "IncludeMessagesFromBlockedSenderAddress": true,
  • "Name": "string",
  • "Preview": true,
  • "QuarantineNotification": true,
  • "ReleaseActionPreference": {
    },
  • "selectedTenants": "string",
  • "TemplateList": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddSpamFilter

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string

PowerShellCommand parameter

Priority
string

Priority parameter

selectedTenants
string

selectedTenants parameter

object

TemplateList parameter

name
string

Body parameter from PS1: name

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "Priority": "string",
  • "selectedTenants": "string",
  • "TemplateList": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddSpamFilterTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddTenantAllowBlockList

Authorizations:
bearerAuth
Request Body schema: application/json
required
entries
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

NoExpiration
boolean
notes
string
RemoveAfter
boolean
tenantID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "entries": "string",
  • "listMethod": {
    },
  • "listType": {
    },
  • "NoExpiration": true,
  • "notes": "string",
  • "RemoveAfter": true,
  • "tenantID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddTenantAllowBlockListTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
entries
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

NoExpiration
boolean
notes
string
RemoveAfter
boolean
templateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "entries": "string",
  • "listMethod": {
    },
  • "listType": {
    },
  • "NoExpiration": true,
  • "notes": "string",
  • "RemoveAfter": true,
  • "templateName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditAntiPhishingFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

RuleName
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
RuleName
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "RuleName": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditMalwareFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

RuleName
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
RuleName
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "RuleName": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditQuarantinePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Type
string
Request Body schema: application/json
required
TenantFilter
required
string
Action
string
AllowSender
string
BlockSender
string
Delete
string
EndUserSpamNotificationCustomFromAddress
string
EndUserSpamNotificationFrequency
string
Identity
string
IncludeMessagesFromBlockedSenderAddress
string
Name
string
OrganizationBrandingEnabled
string
Preview
string
QuarantineNotification
string
ReleaseActionPreference
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AllowSender": "string",
  • "BlockSender": "string",
  • "Delete": "string",
  • "EndUserSpamNotificationCustomFromAddress": "string",
  • "EndUserSpamNotificationFrequency": "string",
  • "Identity": "string",
  • "IncludeMessagesFromBlockedSenderAddress": "string",
  • "Name": "string",
  • "OrganizationBrandingEnabled": "string",
  • "Preview": "string",
  • "QuarantineNotification": "string",
  • "ReleaseActionPreference": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditSafeAttachmentsFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

RuleName
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
RuleName
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "RuleName": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditSpamFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

name
string
Request Body schema: application/json
required
name
string
state
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "state": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecQuarantineManagement

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AllowSender
string
Identity
string
PolicyName
string
SenderAddress
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AllowSender": "string",
  • "Identity": "string",
  • "PolicyName": "string",
  • "SenderAddress": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListConnectionFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListConnectionFilterTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailQuarantine

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailQuarantineMessage

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListQuarantinePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Type
string
Request Body schema: application/json
required
TenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSpamFilterTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSpamfilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantAllowBlockListTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveConnectionfilterTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveQuarantinePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Name
string
Request Body schema: application/json
required
TenantFilter
required
string
Identity
string
Name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSpamfilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

name
string
Request Body schema: application/json
required
name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSpamfilterTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTenantAllowBlockListTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Security > Compliance-Retention

AddRetentionCompliancePolicy

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string
selectedTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddRetentionCompliancePolicyTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditRetentionCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
State
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string
parameters
string
State
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "parameters": "string",
  • "State": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRetentionCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRetentionCompliancePolicyTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveRetentionCompliancePolicy

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
ForceDeletion
string
Identity
string
Name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ForceDeletion": "string",
  • "Identity": "string",
  • "Name": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveRetentionCompliancePolicyTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

CIPP > Scheduler

AddScheduledItem

Authorizations:
bearerAuth
query Parameters
hidden
string

Query parameter from PS1: hidden

DisallowDuplicateName
string

Query parameter from PS1: DisallowDuplicateName

Request Body schema: application/json
required
tenantFilter
required
object

Tenant selector object {value, label, type, addedFields}. 'AllTenants' is a valid value.

advancedParameters
boolean
antiphishing
boolean
antispam
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

ca
boolean
CippCustomVariables
boolean
CippScriptedAlerts
boolean
CippWebhookAlerts
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

email
boolean
groups
boolean
includeRawAttachments
boolean
intunecompliance
boolean
intuneconfig
boolean
intuneprotection
boolean
overwrite
boolean
psa
boolean
removeRemediation
boolean
scheduleName
string
Array of objects (LabelValue)
templateName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Trigger
object

Trigger configuration for triggered tasks. Contains Type, DeltaResource, EventType, ResourceFilter, WatchedAttributes, UseConditions, DeltaConditions, ExecutePerResource, ExecutionMode.

users
boolean
webhook
boolean
Name
string

Task name

command
object

Command selector object {label, value, addedFields}

taskType
object

{'scheduled'|'triggered'}. Determines which scheduling branch is active.

ScheduledTime
integer

Unix timestamp (seconds) for scheduled start. Required when taskType=scheduled.

Recurrence
object

Recurrence option {label, value} e.g. {label:'Every 1 day', value:'1d'}

parameters
object

Key-value map of command parameters. String[] types are sent as arrays.

RawJsonParameters
string

JSON string of parameters when advancedParameters mode is active. Used instead of 'parameters' field.

postExecution
Array of strings

Array of post-execution action objects [{label, value}], e.g. Webhook, Email, PSA

reference
string

Optional note/identifier for the task

RowKey
string

Existing task RowKey when editing/re-running. PS1 uses this for RunNow scenario.

RunNow
boolean

If true, immediately re-runs the task identified by RowKey

DesiredStartTime
string

Optional desired start time override passed to Add-CIPPScheduledTask

DisallowDuplicateName
boolean

Prevent creating duplicate task names. Also readable from query string.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "advancedParameters": true,
  • "antiphishing": true,
  • "antispam": true,
  • "backup": {
    },
  • "blockType": {
    },
  • "ca": true,
  • "CippCustomVariables": true,
  • "CippScriptedAlerts": true,
  • "CippWebhookAlerts": true,
  • "dbCacheType": {
    },
  • "dbFormat": {
    },
  • "email": true,
  • "groups": true,
  • "includeRawAttachments": true,
  • "intunecompliance": true,
  • "intuneconfig": true,
  • "intuneprotection": true,
  • "overwrite": true,
  • "psa": true,
  • "removeRemediation": true,
  • "scheduleName": "string",
  • "selectedTest": [
    ],
  • "templateName": "string",
  • "testSuite": {
    },
  • "Trigger": { },
  • "users": true,
  • "webhook": true,
  • "tenantFilter": { },
  • "Name": "string",
  • "command": { },
  • "taskType": { },
  • "ScheduledTime": 0,
  • "Recurrence": { },
  • "parameters": { },
  • "RawJsonParameters": "string",
  • "postExecution": [
    ],
  • "reference": "string",
  • "RowKey": "string",
  • "RunNow": true,
  • "DesiredStartTime": "string",
  • "DisallowDuplicateName": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListScheduledItemDetails

Authorizations:
bearerAuth
query Parameters
RowKey
string
Request Body schema: application/json
required
RowKey
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListScheduledItems

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Id
string
Name
string
SearchTitle
string
ShowHidden
string
Type
string
Request Body schema: application/json
required
tenantFilter
required
string
Id
string
Name
string
SearchTitle
string
ShowHidden
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Id": "string",
  • "Name": "string",
  • "SearchTitle": "string",
  • "ShowHidden": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveScheduledItem

Removes a scheduled item from CIPP's scheduler. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
id
string
Request Body schema: application/json
required
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Security > Compliance-SIT

AddSensitiveInfoType

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string
selectedTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddSensitiveInfoTypeTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditSensitiveInfoType

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string
parameters
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "parameters": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSensitiveInfoType

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

IncludeBuiltIn
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSensitiveInfoTypeTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSensitiveInfoType

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSensitiveInfoTypeTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Security > Compliance-SensitivityLabel

AddSensitivityLabel

Authorizations:
bearerAuth
Request Body schema: application/json
required
PowerShellCommand
string
selectedTenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PowerShellCommand": "string",
  • "selectedTenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddSensitivityLabelTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string
PowerShellCommand
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "PowerShellCommand": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditSensitivityLabel

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string
parameters
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "parameters": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSensitivityLabel

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSensitivityLabelTemplates

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSensitivityLabel

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
Name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "Name": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveSensitivityLabelTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Administration

AddSharedMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantID
string

Tenant domain/ID. Formatter reads from useSettings().currentTenant and sends as 'tenantID' (not tenantFilter).

displayName
string
username
string

Mailbox alias (local part of email; combined with domain server-side as username@domain)

domain
string

Domain extracted from autocomplete object .value by formatter

addedAliases
string

Newline-separated aliases; PS1 splits on \n. Not sent by default form but accepted.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantID": "string",
  • "displayName": "string",
  • "username": "string",
  • "domain": "string",
  • "addedAliases": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecConvertMailbox

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
MailboxType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "MailboxType": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCopyForSent

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
messageCopyState
string
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
messageCopyState
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "messageCopyState": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEditCalendarPermissions

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

CanViewPrivateItems
string
FolderName
string
Permissions
string
RemoveAccess
string
userid
string
UserToGetPermissions
string
Request Body schema: application/json
required
tenantFilter
required
string
CanViewPrivateItems
string
FolderName
string
Permissions
string
RemoveAccess
string
userid
string
UserToGetPermissions
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "CanViewPrivateItems": "string",
  • "FolderName": "string",
  • "Permissions": "string",
  • "RemoveAccess": "string",
  • "tenantFilter": "string",
  • "userid": "string",
  • "UserToGetPermissions": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEditMailboxPermissions

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantfilter
required
string
AddFullAccess
string
AddFullAccessNoAutoMap
string
AddSendAs
string
AddSendOnBehalf
string
RemoveFullAccess
string
RemoveSendAs
string
RemoveSendOnBehalf
string
userID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AddFullAccess": "string",
  • "AddFullAccessNoAutoMap": "string",
  • "AddSendAs": "string",
  • "AddSendOnBehalf": "string",
  • "RemoveFullAccess": "string",
  • "RemoveSendAs": "string",
  • "RemoveSendOnBehalf": "string",
  • "tenantfilter": "string",
  • "userID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEmailForward

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
ForwardExternal
string
ForwardInternal
string
forwardOption
string
KeepCopy
string
userID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ForwardExternal": "string",
  • "ForwardInternal": "string",
  • "forwardOption": "string",
  • "KeepCopy": "string",
  • "tenantFilter": "string",
  • "userID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEnableArchive

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

id
string
username
string
Request Body schema: application/json
required
tenantFilter
required
string
id
string
username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEnableAutoExpandingArchive

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
ID
string
username
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ID": "string",
  • "tenantFilter": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGroupsDelete

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

displayName
string
GroupType
string
id
string
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
GroupType
string
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGroupsDeliveryManagement

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GroupType
string
ID
string
OnlyAllowInternal
string
Request Body schema: application/json
required
tenantFilter
required
string
GroupType
string
ID
string
OnlyAllowInternal
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GroupType": "string",
  • "ID": "string",
  • "OnlyAllowInternal": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGroupsHideFromGAL

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GroupType
string
HideFromGAL
string
ID
string
Request Body schema: application/json
required
tenantFilter
required
string
GroupType
string
HideFromGAL
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GroupType": "string",
  • "HideFromGAL": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecHVEUser

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string

TenantFilter parameter

displayName
string

displayName parameter

password
string

password parameter

primarySMTPAddress
string

primarySMTPAddress parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "password": "string",
  • "primarySMTPAddress": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecHideFromGAL

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

HideFromGAL
string
ID
string
Request Body schema: application/json
required
tenantFilter
required
string
HideFromGAL
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "HideFromGAL": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecMailboxMobileDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Delete
string
deviceid
string
guid
string
Quarantine
string
Userid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecModifyCalPerms

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
permissions
string
userID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "permissions": "string",
  • "tenantFilter": "string",
  • "userID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecModifyContactPerms

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
permissions
string
userID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "permissions": "string",
  • "tenantFilter": "string",
  • "userID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecModifyMBPerms

Authorizations:
bearerAuth
Request Body schema: application/json
required
One of
Array
tenantFilter
required
string
mailboxRequests
string
permissions
string
userID
string
property name*
additional property
any

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "mailboxRequests": "string",
  • "permissions": "string",
  • "tenantFilter": "string",
  • "userID": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRemoveMailboxRule

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ruleId
string
ruleName
string
userPrincipalName
string
Request Body schema: application/json
required
TenantFilter
required
string
ruleId
string
ruleName
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ruleId": "string",
  • "ruleName": "string",
  • "TenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRemoveRestrictedUser

Removes a user from the restricted senders list in Exchange Online. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
SenderAddress
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "SenderAddress": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecScheduleForwardingVacation

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
endDate
string
ForwardExternal
string
ForwardInternal
string
forwardOption
string
KeepCopy
string
object (PostExecution)

Notification channels triggered after task completion.

reference
string
startDate
string
Users
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "endDate": "string",
  • "ForwardExternal": "string",
  • "ForwardInternal": "string",
  • "forwardOption": "string",
  • "KeepCopy": "string",
  • "postExecution": {
    },
  • "reference": "string",
  • "startDate": "string",
  • "tenantFilter": "string",
  • "Users": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecScheduleMailboxVacation

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
autoMap
string
calendarPermission
string
canViewPrivateItems
string
delegates
string
endDate
string
includeCalendar
string
mailboxOwners
string
permissionTypes
string
object (PostExecution)

Notification channels triggered after task completion.

reference
string
startDate
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "autoMap": "string",
  • "calendarPermission": "string",
  • "canViewPrivateItems": "string",
  • "delegates": "string",
  • "endDate": "string",
  • "includeCalendar": "string",
  • "mailboxOwners": "string",
  • "permissionTypes": "string",
  • "postExecution": {
    },
  • "reference": "string",
  • "startDate": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecScheduleOOOVacation

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AutoDeclineFutureRequestsWhenOOF
string
CreateOOFEvent
string
DeclineEventsForScheduledOOF
string
DeclineMeetingMessage
string
endDate
string
externalMessage
string
internalMessage
string
OOFEventSubject
string
object (PostExecution)

Notification channels triggered after task completion.

reference
string
startDate
string
Users
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AutoDeclineFutureRequestsWhenOOF": "string",
  • "CreateOOFEvent": "string",
  • "DeclineEventsForScheduledOOF": "string",
  • "DeclineMeetingMessage": "string",
  • "endDate": "string",
  • "externalMessage": "string",
  • "internalMessage": "string",
  • "OOFEventSubject": "string",
  • "postExecution": {
    },
  • "reference": "string",
  • "startDate": "string",
  • "tenantFilter": "string",
  • "Users": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetCalendarProcessing

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
additionalResponse
string
addOrganizerToSubject
string
allowConflicts
string
allowRecurringMeetings
string
automaticallyAccept
string
automaticallyProcess
string
bookingWindowInDays
string
deleteComments
string
deleteSubject
string
maxConflicts
string
maximumDurationInMinutes
string
minimumDurationInMinutes
string
processExternalMeetingMessages
string
removeCanceledMeetings
string
removeOldMeetingMessages
string
removePrivateProperty
string
scheduleOnlyDuringWorkHours
string
UPN
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "additionalResponse": "string",
  • "addOrganizerToSubject": "string",
  • "allowConflicts": "string",
  • "allowRecurringMeetings": "string",
  • "automaticallyAccept": "string",
  • "automaticallyProcess": "string",
  • "bookingWindowInDays": "string",
  • "deleteComments": "string",
  • "deleteSubject": "string",
  • "maxConflicts": "string",
  • "maximumDurationInMinutes": "string",
  • "minimumDurationInMinutes": "string",
  • "processExternalMeetingMessages": "string",
  • "removeCanceledMeetings": "string",
  • "removeOldMeetingMessages": "string",
  • "removePrivateProperty": "string",
  • "scheduleOnlyDuringWorkHours": "string",
  • "tenantFilter": "string",
  • "UPN": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetLitigationHold

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
days
string
disable
string
Identity
string
UPN
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "days": "string",
  • "disable": "string",
  • "Identity": "string",
  • "tenantFilter": "string",
  • "UPN": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMailboxEmailSize

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
id
string
maxReceiveSize
string
maxSendSize
string
UPN
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "id": "string",
  • "maxReceiveSize": "string",
  • "maxSendSize": "string",
  • "tenantFilter": "string",
  • "UPN": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMailboxLocale

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
locale
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "locale": "string",
  • "tenantFilter": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMailboxQuota

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantfilter
required
string
IssueWarningQuota
string
ProhibitSendQuota
string
ProhibitSendReceiveQuota
string
quota
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "IssueWarningQuota": "string",
  • "ProhibitSendQuota": "string",
  • "ProhibitSendReceiveQuota": "string",
  • "quota": "string",
  • "tenantfilter": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMailboxRule

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
Disable
string
Enable
string
ruleId
string
ruleName
string
userPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Disable": "string",
  • "Enable": "string",
  • "ruleId": "string",
  • "ruleName": "string",
  • "TenantFilter": "string",
  • "userPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetOoO

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AutoDeclineFutureRequestsWhenOOF
string
AutoReplyState
string
CreateOOFEvent
string
DeclineEventsForScheduledOOF
string
DeclineMeetingMessage
string
EndTime
string
ExternalMessage
string
input
string
InternalMessage
string
OOFEventSubject
string
StartTime
string
timezone
string
userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AutoDeclineFutureRequestsWhenOOF": "string",
  • "AutoReplyState": "string",
  • "CreateOOFEvent": "string",
  • "DeclineEventsForScheduledOOF": "string",
  • "DeclineMeetingMessage": "string",
  • "EndTime": "string",
  • "ExternalMessage": "string",
  • "input": "string",
  • "InternalMessage": "string",
  • "OOFEventSubject": "string",
  • "StartTime": "string",
  • "tenantFilter": "string",
  • "timezone": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetRecipientLimits

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Identity
string
recipientLimit
string
userid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Identity": "string",
  • "recipientLimit": "string",
  • "tenantFilter": "string",
  • "userid": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetRetentionHold

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
disable
string
Identity
string
UPN
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "disable": "string",
  • "Identity": "string",
  • "tenantFilter": "string",
  • "UPN": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecStartManagedFolderAssistant

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Id
string
Request Body schema: application/json
required
tenantFilter
required
string
Id
string
UserPrincipalName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Id": "string",
  • "tenantFilter": "string",
  • "UserPrincipalName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCalendarPermissions

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ByUser
string
UseReportDB
string
UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListContactPermissions

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UserID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxMobileDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Mailbox
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxRules

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxes

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

PSObject
string
UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListOoO

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

userid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRestrictedUsers

Lists users from the restricted senders list in Exchange Online. #> [CmdletBinding()] param($Request, $TriggerMetadata) # Interact with query parameters or the body of the request. $TenantFilter = $Request.Query.tenantFilter

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSharedMailboxStatistics

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListmailboxPermissions

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ByUser
string
UseReportDB
string
userId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Teams-Sharepoint

AddSite

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

sensitivityLabel
string

sensitivityLabel parameter

siteDescription
string

siteDescription parameter

object

siteDesign parameter

siteName
string

siteName parameter

object

siteOwner parameter

object

templateName parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "sensitivityLabel": "string",
  • "siteDescription": "string",
  • "siteDesign": {
    },
  • "siteName": "string",
  • "siteOwner": {
    },
  • "templateName": {
    },
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddSiteBulk

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

bulkSites
string

bulkSites parameter

sensitivityLabel
string

sensitivityLabel parameter

siteDescription
string

siteDescription parameter

siteDesign
string

siteDesign parameter

siteName
string

siteName parameter

siteOwner
string

siteOwner parameter

templateName
string

templateName parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "bulkSites": "string",
  • "sensitivityLabel": "string",
  • "siteDescription": "string",
  • "siteDesign": "string",
  • "siteName": "string",
  • "siteOwner": "string",
  • "templateName": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddTeam

Authorizations:
bearerAuth
Request Body schema: application/json
required
displayName
string
description
string
owner
string

Owner UPN extracted from user selector .value by formatter. PS1 passes as member@odata.bind with role 'owner'.

visibility
string

Enum: 'public' | 'private'. Default 'public'.

tenantid
string

Body parameter from PS1: tenantid

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "description": "string",
  • "owner": "string",
  • "visibility": "string",
  • "tenantid": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

DeleteSharepointSite

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
SiteId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "SiteId": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRemoveTeamsVoicePhoneNumberAssignment

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AssignedTo
string
PhoneNumber
string
PhoneNumberType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AssignedTo": "string",
  • "PhoneNumber": "string",
  • "PhoneNumberType": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetSharePointMember

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Add
string
GroupID
string
SharePointType
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Add": "string",
  • "GroupID": "string",
  • "SharePointType": "string",
  • "tenantFilter": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSharePointPerms

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
onedriveAccessUser
string
RemovePermission
string
UPN
string
URL
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "onedriveAccessUser": "string",
  • "RemovePermission": "string",
  • "tenantFilter": "string",
  • "UPN": "string",
  • "URL": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecTeamsVoicePhoneNumberAssignment

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
input
string
locationOnly
string
PhoneNumber
string
PhoneNumberType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "input": "string",
  • "locationOnly": "string",
  • "PhoneNumber": "string",
  • "PhoneNumberType": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSharepointAdminUrl

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ReturnUrl
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSharepointQuota

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSharepointSettings

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSiteMembers

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

SiteId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSites

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Type
string
URLOnly
string
UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTeams

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string
type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTeamsActivity

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTeamsLisLocation

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTeamsVoice

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Standards

AddStandardsDeploy

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenant
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

AddStandardsTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
createdAt
string
GUID
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

templateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "GUID": "string",
  • "policySource": {
    },
  • "templateName": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

BestPracticeAnalyser_List

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBPA

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Request Body schema: application/json
required
tenantfilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDomainAnalyser

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDriftClone

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecStandardConvert

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecStandardsRun

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

templateId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUpdateDriftDeviation

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
deviations
string
persistentDeny
string
reason
string
RemoveDriftCustomization
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "deviations": "string",
  • "persistentDeny": "string",
  • "reason": "string",
  • "RemoveDriftCustomization": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListBPA

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Report
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListBPATemplates

Authorizations:
bearerAuth
query Parameters
RawJson
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDomainAnalyser

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDomainHealth

Authorizations:
bearerAuth
query Parameters
Action
string
Domain
string
ExpectedInclude
string
ExpectedTarget
string
Record
string
Selector
string
Subdomains
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListStandards

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ShowConsolidated
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListStandardsCompare

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

templateId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListStandardsCurrentState

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantAlignment

Authorizations:
bearerAuth
query Parameters
granular
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantDrift

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveBPATemplate

Authorizations:
bearerAuth
query Parameters
TemplateName
string
Request Body schema: application/json
required
TemplateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveStandard

Authorizations:
bearerAuth
query Parameters
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveStandardTemplate

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

listStandardTemplates

Authorizations:
bearerAuth
query Parameters
id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Administration > Tenant

AddTenant

Authorizations:
bearerAuth
query Parameters
Action
string
TenantName
string
Request Body schema: application/json
required
Action
string
AddressLine1
string
AddressLine2
string
City
string
CompanyName
string
Country
string
Email
string
FirstName
string
LastName
string
PhoneNumber
string
PostalCode
string
State
string
TenantName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AddressLine1": "string",
  • "AddressLine2": "string",
  • "City": "string",
  • "CompanyName": "string",
  • "Country": "string",
  • "Email": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "PhoneNumber": "string",
  • "PostalCode": "string",
  • "State": "string",
  • "TenantName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditTenant

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

tenantGroups
string

(auto) API uses 'tenantGroups', frontend sends 'Groups' — likely the same field (similarity=0.67). Verify and correct type.

tenantAlias
string

(auto) API uses 'tenantAlias', frontend sends 'Alias' — likely the same field (similarity=0.62). Verify and correct type.

customerId
string

Body parameter from PS1: customerId

GroupId
string

Body parameter from PS1: GroupId

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "selectedGroup": {
    },
  • "tenantGroups": "string",
  • "tenantAlias": "string",
  • "customerId": "string",
  • "GroupId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

EditTenantOffboardingDefaults

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Alias
string

Alias parameter

customerId
string

customerId parameter

defaultDomainName
string

defaultDomainName parameter

object

Groups parameter

offboardingDefaults
string

offboardingDefaults parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "selectedGroup": {
    },
  • "Alias": "string",
  • "customerId": "string",
  • "defaultDomainName": "string",
  • "Groups": {
    },
  • "offboardingDefaults": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantDetails

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenants

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AllTenantSelector
string

AllTenantSelector parameter

IncludeOffboardingDefaults
string

IncludeOffboardingDefaults parameter

Mode
string

Mode parameter

TriggerRefresh
string

TriggerRefresh parameter

Request Body schema: application/json
required
ClearCache
string

ClearCache parameter

object

integrationCompany parameter

TenantsOnly
string

TenantsOnly parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ClearCache": "string",
  • "integrationCompany": {
    },
  • "TenantsOnly": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTenantCapabilitiesCache

Authorizations:
bearerAuth
query Parameters
defaultDomainName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Uncategorized

AddTestReport

Authorizations:
bearerAuth
Request Body schema: application/json
required
CustomTests
string
name
string

name parameter

ReportId
string
description
string

description parameter

DevicesTests
string

DevicesTests parameter

IdentityTests
string

IdentityTests parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "CustomTests": "string",
  • "name": "string",
  • "ReportId": "string",
  • "description": "string",
  • "DevicesTests": "string",
  • "IdentityTests": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

DeleteTestReport

Authorizations:
bearerAuth
Request Body schema: application/json
required
ReportId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBitlockerSearch

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

deviceId
string
keyId
string
limit
string
Request Body schema: application/json
required
tenantFilter
required
string
deviceId
string
keyId
string
limit
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "deviceId": "string",
  • "keyId": "string",
  • "limit": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBreachSearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCSPLicense

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
Add
string
iagree
boolean
Quantity
number
Remove
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

SubscriptionIds
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Add": "string",
  • "iagree": true,
  • "Quantity": 0,
  • "Remove": "string",
  • "SKU": {
    },
  • "SubscriptionIds": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCSPLicense

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
Add
string
iagree
boolean
Quantity
number
Remove
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

SubscriptionIds
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Add": "string",
  • "iagree": true,
  • "Quantity": 0,
  • "Remove": "string",
  • "SKU": {
    },
  • "SubscriptionIds": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExtensionNinjaOneQueue

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecLicenseSearch

Authorizations:
bearerAuth
Request Body schema: application/json
required
skuIds
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecListAppId

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecListAppId

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSchedulerBillingRun

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSendOrgMessage

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

freq
string
ID
string
type
string
URL
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecTestRefresh

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

testName
string
Request Body schema: application/json
required
tenantFilter
required
string
testName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "testName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecTestRun

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUniversalSearch

Authorizations:
bearerAuth
query Parameters
name
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUniversalSearchV2

Authorizations:
bearerAuth
query Parameters
limit
string
searchTerms
string
type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUserBookmarks

Authorizations:
bearerAuth
Request Body schema: application/json
required
currentSettings
string
user
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "currentSettings": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUserSettings

Authorizations:
bearerAuth
Request Body schema: application/json
required
currentSettings
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "currentSettings": "string",
  • "user": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAllTenantDeviceCompliance

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppStatus

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AppFilter
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAvailableTests

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string

(auto) detected in frontend form/call

description
string

(auto) detected in frontend form/call

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListBreachesAccount

Authorizations:
bearerAuth
query Parameters
account
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListBreachesTenant

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCSPLicenses

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCSPsku

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

currentSkuOnly
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCheckExtAlerts

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCippQueue

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDBCache

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDetectedAppDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AppID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDetectedApps

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DeviceID
string
includeDevices
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDeviceDetails

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DeviceID
string
DeviceName
string
DeviceSerial
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExtensionsConfig

Authorizations:
bearerAuth
Request Body schema: application/json
required
Description
string
includeforks
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Private
boolean
repoName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Description": "string",
  • "includeforks": true,
  • "orgName": {
    },
  • "Private": true,
  • "repoName": "string",
  • "searchTerm": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExternalTenantInfo

Authorizations:
bearerAuth
query Parameters
tenant
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListFunctionParameters

Authorizations:
bearerAuth
query Parameters
Compliance
string
Function
string
Module
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListFunctionStats

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

FunctionType
string
Interval
string
Time
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGenericTestFunction

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGraphExplorerPresets

Authorizations:
bearerAuth
query Parameters
Endpoint
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListHaloClients

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIPWhitelist

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListIntuneIntents

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListKnownIPDb

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListLogs

Authorizations:
bearerAuth
query Parameters
API
string
DateFilter
string
EndDate
string
Filter
string
ListLogs
string
logentryid
string
ScheduledTaskId
string
Severity
string
StandardTemplateId
string
StartDate
string
Tenant
string
User
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListNamedLocations

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListNotificationConfig

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListOrg

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListPartnerRelationships

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListPendingWebhooks

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListPotentialApps

Authorizations:
bearerAuth
Request Body schema: application/json
required
AcceptLicense
boolean
applicationName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

arch
boolean
AssignTo
string
Enum: "On" "allLicensedUsers" "AllDevices" "AllDevicesAndUsers" "customGroup"
customArguments
string
customGroup
string
customRepo
string
customXml
string
description
string
detectionFile
string
detectionPath
string
detectionScript
string
DisableRestart
boolean
displayName
string
enforceSignatureCheck
boolean
Array of objects (LabelValue)
InstallAsSystem
boolean
InstallationIntent
boolean
installScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

packagename
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object
publisher
string
RemoveVersions
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

runAs32Bit
boolean
searchQuery
string
SearchString
string
SharedComputerActivation
boolean
templateDescription
string
templateName
string
type
string
uninstallScript
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

useCustomXml
boolean
useDetectionScript
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AcceptLicense": true,
  • "applicationName": "string",
  • "appType": {
    },
  • "arch": true,
  • "AssignTo": "On",
  • "customArguments": "string",
  • "customGroup": "string",
  • "customRepo": "string",
  • "customXml": "string",
  • "description": "string",
  • "detectionFile": "string",
  • "detectionPath": "string",
  • "detectionScript": "string",
  • "DisableRestart": true,
  • "displayName": "string",
  • "enforceSignatureCheck": true,
  • "excludedApps": [
    ],
  • "InstallAsSystem": true,
  • "InstallationIntent": true,
  • "installScript": "string",
  • "languages": {
    },
  • "packagename": "string",
  • "packageSearch": {
    },
  • "params": {
    },
  • "publisher": "string",
  • "RemoveVersions": true,
  • "rmmname": {
    },
  • "runAs32Bit": true,
  • "searchQuery": "string",
  • "SearchString": "string",
  • "SharedComputerActivation": true,
  • "templateDescription": "string",
  • "templateName": "string",
  • "type": "string",
  • "uninstallScript": "string",
  • "updateChannel": {
    },
  • "useCustomXml": true,
  • "useDetectionScript": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListResellerRelationshipLink

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListRoles

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantAllowBlockList

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Lists all available test reports from JSON files and database

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Lists tests for a tenant, optionally filtered by report ID

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

reportId
string
Request Body schema: application/json
required
tenantFilter
required
string
reportId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "reportId": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListUsersAndGroups

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

PublicPhishingCheck

Authorizations:
bearerAuth
Request Body schema: application/json
required
AlertMessage
string
Cloned
string
reason
string
score
string
source
string
TenantId
string
threshold
string
type
string
url
string
userDisplayName
string
userEmail
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AlertMessage": "string",
  • "Cloned": "string",
  • "reason": "string",
  • "score": "string",
  • "source": "string",
  • "TenantId": "string",
  • "threshold": "string",
  • "type": "string",
  • "url": "string",
  • "userDisplayName": "string",
  • "userEmail": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveCippQueue

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveTenantAllowBlockList

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Entries
string
ListType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Entries": "string",
  • "ListType": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

RemoveWebhookAlert

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

CIPP > Settings

ExecAPIPermissionList

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAccessChecks

Authorizations:
bearerAuth
query Parameters
SkipCache
string
Type
string
Request Body schema: application/json
required
TenantId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAddTrustedIP

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantfilter
required
string

tenantfilter parameter

IP
string

IP parameter

ipAddress
string

ipAddress parameter

State
string

State parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "IP": "string",
  • "ipAddress": "string",
  • "State": "string",
  • "tenantfilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecApiClient

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
Action
string
AppName
string
CIPPAPI
string
ClientId
string
Enabled
boolean
IpRange
string
RemoveAppReg
string
Role
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AppName": "string",
  • "CIPPAPI": "string",
  • "ClientId": "string",
  • "Enabled": true,
  • "IpRange": "string",
  • "RemoveAppReg": "string",
  • "Role": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBackendURLs

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBackupRetentionConfig

Authorizations:
bearerAuth
query Parameters
List
string
Request Body schema: application/json
required
RetentionDays
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecBrandingSettings

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
Action
string
colour
string
logo
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "colour": "string",
  • "logo": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCPVPermissions

Authorizations:
bearerAuth
query Parameters
ResetSP
string
Request Body schema: application/json
required
tenantFilter
required
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCippReplacemap

Authorizations:
bearerAuth
query Parameters
Action
string
tenantId
string
Request Body schema: application/json
required
Action
string
Description
string
RowKey
string
tenantId
string
Value
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Description": "string",
  • "RowKey": "string",
  • "tenantId": "string",
  • "Value": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Create default tenant groups

This function creates a set of default tenant groups that are commonly used .FUNCTIONALITY Entrypoint,AnyTenant .ROLE Tenant.Groups.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCustomData

Authorizations:
bearerAuth
query Parameters
Action
string
id
string
targetObject
string
Request Body schema: application/json
required
Action
string
dataType
string
id
string
isMultiValued
string
Mapping
string
name
string
schemaExtension
string
status
string
targetObjects
string
type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "dataType": "string",
  • "id": "string",
  • "isMultiValued": "string",
  • "Mapping": "string",
  • "name": "string",
  • "schemaExtension": "string",
  • "status": "string",
  • "targetObjects": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCustomRole

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
Action
string
AllowedTenants
string
BlockedEndpoints
string
BlockedTenants
string
EntraGroup
string
IpRange
string
NewRoleName
string
Permissions
string
RoleName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AllowedTenants": "string",
  • "BlockedEndpoints": "string",
  • "BlockedTenants": "string",
  • "EntraGroup": "string",
  • "IpRange": "string",
  • "NewRoleName": "string",
  • "Permissions": "string",
  • "RoleName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDnsConfig

Authorizations:
bearerAuth
query Parameters
Action
string
Domain
string
Resolver
string
Selector
string
Request Body schema: application/json
required
Action
string
Domain
string
Resolver
string
Selector
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Domain": "string",
  • "Resolver": "string",
  • "Selector": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExchangeRoleRepair

Authorizations:
bearerAuth
query Parameters
tenantId
string
Request Body schema: application/json
required
tenantId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExcludeLicenses

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string
FullReset
string
GUID
string
SKUName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "FullReset": "string",
  • "GUID": "string",
  • "SKUName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExcludeTenant

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AddExclusion
string
List
string
ListAll
string
RemoveExclusion
string
Request Body schema: application/json
required
value
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tests the complete GDAP (Granular Delegated Admin Privileges) access path for a user.

GDAP Access Path Testing: 1. Validates input parameters (TenantFilter and UPN) 2. Retrieves customer tenant information 3. Gets all active GDAP relationships for the customer tenant 4. Locates the UPN in the partner tenant 5. Gets user's transitive group memberships (handles nested groups automatically) 6. For each GDAP relationship: - Retrieves all access assignments (mapped security groups) - For each group: checks user membership (direct or nested) and traces the path - Maps roles to relationships and groups 7. For each of the 15 GDAP roles: - Finds all relationships/groups that have this role assigned - Checks if user is a member of any group with this role - Builds complete access path showing how user gets the role (if they do) 8. Returns comprehensive JSON with role-centric view and complete path traces

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UPN
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecJITAdminSettings

Authorizations:
bearerAuth
query Parameters
Action
string

GET requests use Action=Get query param. POST uses body.

Request Body schema: application/json
required
Action
string

Always 'Set' when posting from this form. Also accepted via query string. PS1 switches on this value.

MaxDuration
string

ISO 8601 duration string (e.g. 'PT4H', 'P1D', 'P28D') or null/empty for no limit. Formatter sends MaxDuration?.value ?? null — unwraps from autocomplete object.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "MaxDuration": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecLogRetentionConfig

Authorizations:
bearerAuth
query Parameters
List
string
Request Body schema: application/json
required
RetentionDays
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecMaintenanceScripts

Authorizations:
bearerAuth
query Parameters
MakeLink
string
ScriptFile
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecNotificationConfig

Authorizations:
bearerAuth
Request Body schema: application/json
required
UseStandardizedSchema
string
webhookAuthHeaderName
string
webhookAuthHeaders
string
webhookAuthHeaderValue
string
webhookAuthPassword
string
webhookAuthToken
string
webhookAuthType
string
webhookAuthUsername
string
email
string

(auto) from CippNotificationForm.jsx

webhook
string

(auto) from CippNotificationForm.jsx

object

(auto) from CippNotificationForm.jsx

object

(auto) from CippNotificationForm.jsx

onePerTenant
boolean

(auto) from CippNotificationForm.jsx

sendtoIntegration
boolean

(auto) from CippNotificationForm.jsx

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "UseStandardizedSchema": "string",
  • "webhookAuthHeaderName": "string",
  • "webhookAuthHeaders": "string",
  • "webhookAuthHeaderValue": "string",
  • "webhookAuthPassword": "string",
  • "webhookAuthToken": "string",
  • "webhookAuthType": "string",
  • "webhookAuthUsername": "string",
  • "email": "string",
  • "webhook": "string",
  • "logsToInclude": {
    },
  • "Severity": {
    },
  • "onePerTenant": true,
  • "sendtoIntegration": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOffloadFunctions

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
OffloadFunctions
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecPartnerMode

Authorizations:
bearerAuth
query Parameters
action
string
Request Body schema: application/json
required
TenantMode
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecPasswordConfig

Authorizations:
bearerAuth
query Parameters
List
string
Request Body schema: application/json
required
appendNumber
string
appendSpecialChar
string
capitalizeWords
string
charCount
string
includeDigits
string
includeLowercase
string
includeSpecialChars
string
includeUppercase
string
passwordType
string
separator
string
specialCharSet
string
wordCount
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "appendNumber": "string",
  • "appendSpecialChar": "string",
  • "capitalizeWords": "string",
  • "charCount": "string",
  • "includeDigits": "string",
  • "includeLowercase": "string",
  • "includeSpecialChars": "string",
  • "includeUppercase": "string",
  • "passwordType": "string",
  • "separator": "string",
  • "specialCharSet": "string",
  • "wordCount": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

This endpoint will update the CIPP-SAM app permissions.

Merges new permissions from the SAM manifest into the AppPermissions entry for CIPP-SAM. .FUNCTIONALITY Entrypoint .ROLE CIPP.AppSettings.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRemoveTenant

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRestoreBackup

Authorizations:
bearerAuth
Request Body schema: application/json
required
BackupName
string
SelectedTypes
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "BackupName": "string",
  • "SelectedTypes": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRunBackup

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Execute tenant group dynamic rules immediately

This function executes dynamic tenant group rules for immediate membership updates .FUNCTIONALITY Entrypoint,AnyTenant .ROLE Tenant.Groups.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
groupId
string
Request Body schema: application/json
required
groupId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSAMAppPermissions

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
Permissions
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSAMRoles

Authorizations:
bearerAuth
query Parameters
Action
string
Request Body schema: application/json
required
Roles
string
Tenants
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Roles": "string",
  • "Tenants": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Entrypoint for tenant group management

This function is used to manage tenant groups in CIPP .FUNCTIONALITY Entrypoint,AnyTenant .ROLE Tenant.Groups.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string

Dispatch action. Formatter hard-codes 'AddEdit'. PS1 supports: AddEdit, Delete. Defaults handled by switch.

groupId
string

Group GUID. For edit form this is pre-populated from router query. PS1 auto-generates a new GUID if not provided.

groupName
string

Display name for the tenant group.

groupDescription
string
groupType
string
Enum: "static" "dynamic"

Enum: 'static'|'dynamic'. PS1 defaults to 'static' if not provided.

members
Array of strings

Array of {label, value: customerId} tenant objects. Used only for static groups.

dynamicRules
Array of strings

Array of rule objects [{property: string, operator: string, value: any}]. Formatter unwraps property/operator from {label,value} objects. Required when groupType='dynamic'.

ruleLogic
string

Logic for combining dynamic rules. Enum: 'and'|'or'. PS1 defaults to 'and'.

value
string

Body parameter from PS1: value

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "groupId": "string",
  • "groupName": "string",
  • "groupDescription": "string",
  • "groupType": "static",
  • "members": [
    ],
  • "dynamicRules": [
    ],
  • "ruleLogic": "string",
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecTimeSettings

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Timezone": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecWebhookSubscriptions

Authorizations:
bearerAuth
query Parameters
Action
string
WebhookID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCustomRole

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCustomVariables

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

excludeGlobalReserved
string
includeSystem
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExcludedLicenses

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Entrypoint for listing tenant groups

Authorizations:
bearerAuth
query Parameters
groupId
string
includeUsage
string
Request Body schema: application/json
required
groupId
string
includeUsage
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "includeUsage": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

CIPP > Core

ExecAddAlert

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
sendEmailNow
string
sendPsaNow
string
sendWebhookNow
string
text
string
writeLog
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "sendEmailNow": "string",
  • "sendPsaNow": "string",
  • "sendWebhookNow": "string",
  • "tenantFilter": "string",
  • "text": "string",
  • "writeLog": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAppInsightsQuery

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Execute a AzBobbyTables function

This function is used to interact with Azure Tables. This is advanced functionality used for external integrations or SuperAdmin functionality. .FUNCTIONALITY Entrypoint .ROLE CIPP.SuperAdmin.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata) $AllowList = @( 'Add-AzDataTableEntity' 'Add-CIPPAzDataTableEntity' 'Update-AzDataTableEntity' 'Get-AzDataTableEntity' 'Get-CIPPAzDataTableEntity' 'Get-AzDataTable' 'New-AzDataTable' 'Remove-AzDataTableEntity' 'Remove-AzDataTable' )

Authorizations:
bearerAuth
Request Body schema: application/json
required
FunctionName
string

FunctionName parameter

OffloadFunctions
boolean

OffloadFunctions parameter

Parameters
string

Parameters parameter

TableName
string

TableName parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "FunctionName": "string",
  • "OffloadFunctions": true,
  • "Parameters": "string",
  • "TableName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCIPPDBCache

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Name
string
Types
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

This endpoint is used to trigger a refresh of CPV for all tenants

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Execute a CIPPCore function

This function is used to execute a CIPPCore function from an HTTP request. This is advanced functionality used for external integrations or SuperAdmin functionality. .FUNCTIONALITY Entrypoint .ROLE CIPP.SuperAdmin.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata) $BlockList = @( 'Get-GraphToken' 'Get-GraphTokenFromCert' 'Get-ClassicAPIToken' )

Authorizations:
bearerAuth
Request Body schema: application/json
required
FunctionName
string
Parameters
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "FunctionName": "string",
  • "Parameters": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Generate a read-only SAS token for the CippLogs table

Creates a long-lived, read-only SAS URL for the CippLogs Azure Storage table. .FUNCTIONALITY Entrypoint .ROLE CIPP.AppSettings.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
Days
string
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Days": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCloneTemplate

Authorizations:
bearerAuth
query Parameters
GUID
string
Type
string
Request Body schema: application/json
required
GUID
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDiagnosticsPresets

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

name
string

(auto) API uses 'name', frontend sends 'presetName' — likely the same field (similarity=0.57). Verify and correct type.

action
string

Body parameter from PS1: action

GUID
string

Body parameter from PS1: GUID

query
string

Body parameter from PS1: query

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "queryPreset": {
    },
  • "name": "string",
  • "action": "string",
  • "GUID": "string",
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDurableFunctions

Authorizations:
bearerAuth
query Parameters
Action
string
PartitionKey
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecEditTemplate

Authorizations:
bearerAuth
query Parameters
Type
string
Request Body schema: application/json
required
description
string
displayName
string
GUID
string
id
string
name
string
parsedRAWJson
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "description": "string",
  • "displayName": "string",
  • "GUID": "string",
  • "id": "string",
  • "name": "string",
  • "parsedRAWJson": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecFeatureFlag

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string
Enabled
boolean
Id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Enabled": true,
  • "Id": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGeoIPLookup

Authorizations:
bearerAuth
query Parameters
IP
string
Request Body schema: application/json
required
IP
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGraphRequestProfile

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Endpoint
string
manualPagination
string
Mode
string
Reset
string
Version
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecListBackup

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

BackupName
string
NameOnly
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecPartnerWebhook

Authorizations:
bearerAuth
query Parameters
Action
string
CorrelationId
string
Request Body schema: application/json
required
enabled
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

standardsExcludeAllTenants
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "enabled": true,
  • "EventType": {
    },
  • "standardsExcludeAllTenants": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecRemoveSnooze

Authorizations:
bearerAuth
query Parameters
PartitionKey
string
RowKey
string
Request Body schema: application/json
required
PartitionKey
string
RowKey
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "PartitionKey": "string",
  • "RowKey": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecServicePrincipals

Authorizations:
bearerAuth
query Parameters
Action
string
AppId
string
Id
string
Select
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetCIPPAutoBackup

Authorizations:
bearerAuth
Request Body schema: application/json
required
Enabled
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Enabled": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetPackageTag

Authorizations:
bearerAuth
Request Body schema: application/json
required
GUID
string
Package
string
Remove
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "Package": "string",
  • "Remove": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSnoozeAlert

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
AlertItem
string
CmdletName
string
Duration
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AlertItem": "string",
  • "CmdletName": "string",
  • "Duration": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

GetCippAlerts

Authorizations:
bearerAuth
query Parameters
localversion
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

GetVersion

Authorizations:
bearerAuth
query Parameters
LocalVersion
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAdminPortalLicenses

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListApiTest

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListCustomDataMappings

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

directoryObject
string
sourceType
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDiagnosticsPresets

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDirectoryObjects

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
asApp
string
ids
string
partnerLookup
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "asApp": "string",
  • "ids": "string",
  • "partnerLookup": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

List Extension Cache Data

This function is used to list the extension cache data. .FUNCTIONALITY Entrypoint .ROLE CIPP.Core.Read #> [CmdletBinding()] param($Request, $TriggerMetadata) $TenantFilter = $Request.Query.tenantFilter ?? $Request.Body.tenantFilter $DataTypes = $Request.Query.dataTypes -split ',' ?? $Request.Body.dataTypes ?? 'All'

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

dataTypes
string
Request Body schema: application/json
required
tenantFilter
required
string
dataTypes
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "dataTypes": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListFeatureFlags

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGraphBulkRequest

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
asApp
string
noPaginateIds
string
requests
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "asApp": "string",
  • "noPaginateIds": "string",
  • "requests": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGraphRequest

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

AsApp
string
CountOnly
string
Endpoint
string
expand
string
graphFilter
string

OData $filter expression passed to Graph

IgnoreErrors
string
ListProperties
string
manualPagination
string
nextLink
string
NoPagination
string
QueueId
string
QueueNameOverride
string
ReverseTenantLookup
string
ReverseTenantLookupProperty
string
SkipCache
string
Sort
string
Version
string
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

includeRawAttachments
boolean
object
Array of objects (LabelValue)
object
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

removeRemediation
boolean
scheduleName
string
Array of objects (LabelValue)
templateName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "blockType": {
    },
  • "dbCacheType": {
    },
  • "dbFormat": {
    },
  • "includeRawAttachments": true,
  • "ooo": {
    },
  • "postExecution": [
    ],
  • "recipientLimits": {
    },
  • "recurrence": {
    },
  • "removeRemediation": true,
  • "scheduleName": "string",
  • "selectedTest": [
    ],
  • "templateName": "string",
  • "testSuite": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSnoozedAlerts

Authorizations:
bearerAuth
query Parameters
CmdletName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

PublicPing

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > GDAP

ExecAddGDAPRole

Authorizations:
bearerAuth
query Parameters
Action
string

Query parameter from PS1: Action

Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

inviteCount
number
Reference
string
Action
string

Dispatch action. Formatter sends 'AddRoleAdvanced' when advancedMode=true, or omits Action (defaults to 'AddRoleSimple') when false. PS1 defaults to 'AddRoleSimple' if not provided. Valid: AddRoleSimple, AddRoleAdvanced, ListGroups.

gdapRoles
Array of strings

Array of {label, value} role objects. Used in AddRoleSimple mode. PS1 reads $Request.Body.gdapRoles.

customSuffix
string

Optional group name suffix. Used in AddRoleSimple mode.

templateId
string

If set, adds role mappings to this GDAP template. Used in AddRoleSimple mode.

mappings
string

Body parameter from PS1: mappings

replace
string

Body parameter from PS1: replace

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "gdapTemplate": {
    },
  • "inviteCount": 0,
  • "Reference": "string",
  • "Action": "string",
  • "gdapRoles": [
    ],
  • "customSuffix": "string",
  • "templateId": "string",
  • "mappings": "string",
  • "replace": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAutoExtendGDAP

Authorizations:
bearerAuth
query Parameters
ID
string
Request Body schema: application/json
required
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDeleteGDAPRelationship

Authorizations:
bearerAuth
query Parameters
GDAPId
string
Request Body schema: application/json
required
GDAPId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDeleteGDAPRoleMapping

Authorizations:
bearerAuth
query Parameters
GroupId
string
Request Body schema: application/json
required
GroupId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGDAPAccessAssignment

Authorizations:
bearerAuth
query Parameters
Action
string
Id
string
Request Body schema: application/json
required
Action
string
Id
string
RoleTemplateId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Id": "string",
  • "RoleTemplateId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGDAPInvite

Authorizations:
bearerAuth
query Parameters
Action
string

Action parameter

Request Body schema: application/json
required
Action
string

Action parameter

object

gdapTemplate parameter

inviteCount
number

inviteCount parameter

InviteId
string

InviteId parameter

Reference
string

Reference parameter

object

roleMappings parameter

roleDefinitionId
string

Body parameter from PS1: roleDefinitionId

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "gdapTemplate": {
    },
  • "inviteCount": 0,
  • "InviteId": "string",
  • "Reference": "string",
  • "roleMappings": {
    },
  • "roleDefinitionId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGDAPInviteApproved

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGDAPRemoveGArole

Authorizations:
bearerAuth
query Parameters
GDAPId
string
Request Body schema: application/json
required
GDAPId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecGDAPRoleTemplate

Authorizations:
bearerAuth
query Parameters
Action
string

Action parameter

TemplateId
string

TemplateId parameter

Request Body schema: application/json
required
object

gdapTemplate parameter

GroupId
string

GroupId parameter

inviteCount
number

inviteCount parameter

OriginalTemplateId
string

OriginalTemplateId parameter

Reference
string

Reference parameter

object

RoleMappings parameter

TemplateId
string

TemplateId parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "gdapTemplate": {
    },
  • "GroupId": "string",
  • "inviteCount": 0,
  • "OriginalTemplateId": "string",
  • "Reference": "string",
  • "RoleMappings": {
    },
  • "TemplateId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPAccessAssignments

Authorizations:
bearerAuth
query Parameters
Id
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPContracts

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPInvite

Authorizations:
bearerAuth
query Parameters
RelationshipId
string
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

ignoreMissingRoles
boolean
remapRoles
string
standardsExcludeAllTenants
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "gdapRoles": {
    },
  • "id": {
    },
  • "ignoreMissingRoles": true,
  • "remapRoles": "string",
  • "standardsExcludeAllTenants": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPRelationships

Authorizations:
bearerAuth
query Parameters
id
string
Request Body schema: application/json
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

ignoreMissingRoles
boolean
remapRoles
string
standardsExcludeAllTenants
boolean

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "gdapRoles": {
    },
  • "id": {
    },
  • "ignoreMissingRoles": true,
  • "remapRoles": "string",
  • "standardsExcludeAllTenants": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPRoles

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGDAPServicePrincipals

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ownerType
string
vendorTenantIds
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Administration > Application Approval

ExecAddMultiTenantApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
AppId
string
configMode
string
CopyPermissions
string
permissions
string
selectedTemplate
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AppId": "string",
  • "configMode": "string",
  • "CopyPermissions": "string",
  • "permissions": "string",
  • "selectedTemplate": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAppApproval

Authorizations:
bearerAuth
query Parameters
ApplicationId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAppApprovalTemplate

Authorizations:
bearerAuth
query Parameters
Action
string
TemplateId
string
Request Body schema: application/json
required
Action
string
ApplicationManifest
string
AppType
string
TemplateId
string
TemplateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "ApplicationManifest": "string",
  • "AppType": "string",
  • "TemplateId": "string",
  • "TemplateName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecAppPermissionTemplate

Authorizations:
bearerAuth
query Parameters
Action
string
TemplateId
string
Request Body schema: application/json
required
Action
string
Permissions
string
TemplateId
string
TemplateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Permissions": "string",
  • "TemplateId": "string",
  • "TemplateName": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecApplication

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Action
string
AppId
string
Id
string
Type
string
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
AppId
string
Id
string
KeyIds
string
Payload
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AppId": "string",
  • "Id": "string",
  • "KeyIds": "string",
  • "Payload": "string",
  • "tenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCreateAppTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
AppId
string
DisplayName
string
Overwrite
string
Type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "AppId": "string",
  • "DisplayName": "string",
  • "Overwrite": "string",
  • "TenantFilter": "string",
  • "Type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecManageAppCredentials

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
Action
string
AppId
string
AppType
string
CredentialType
string
Id
string
KeyId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "AppId": "string",
  • "AppType": "string",
  • "CredentialType": "string",
  • "Id": "string",
  • "KeyId": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppApprovalTemplates

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Administration

ExecAddSPN

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOffboardTenant

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

RemoveCSPGuestUsers
boolean
RemoveCSPnotificationContacts
boolean
RemoveDomainAnalyserData
boolean
RemoveMultitenantCSPApps
boolean
TerminateContract
boolean
TerminateGDAP
boolean
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "RemoveCSPGuestUsers": true,
  • "RemoveCSPnotificationContacts": true,
  • "RemoveDomainAnalyserData": true,
  • "RemoveMultitenantCSPApps": true,
  • "TenantFilter": {
    },
  • "TerminateContract": true,
  • "TerminateGDAP": true,
  • "vendorApplications": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecOnboardTenant

Authorizations:
bearerAuth
Request Body schema: application/json
required
addMissingGroups
string

addMissingGroups parameter

autoMapRoles
string

autoMapRoles parameter

Cancel
string

Cancel parameter

object

gdapRoles parameter

object

id parameter

ignoreMissingRoles
boolean

ignoreMissingRoles parameter

remapRoles
string

remapRoles parameter

Retry
string

Retry parameter

standardsExcludeAllTenants
boolean

standardsExcludeAllTenants parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "addMissingGroups": "string",
  • "autoMapRoles": "string",
  • "Cancel": "string",
  • "gdapRoles": {
    },
  • "id": {
    },
  • "ignoreMissingRoles": true,
  • "remapRoles": "string",
  • "Retry": "string",
  • "standardsExcludeAllTenants": true
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUpdateSecureScore

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
ControlName
string
reason
string
resolutionType
string
vendorInformation
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "ControlName": "string",
  • "reason": "string",
  • "resolutionType": "string",
  • "TenantFilter": "string",
  • "vendorInformation": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAppConsentRequests

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Filter
string
RequestStatus
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListDomains

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListOffboardTenants

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListTenantOnboarding

Authorizations:
bearerAuth
Request Body schema: application/json
required
standardsExcludeAllTenants
string

(auto) detected in frontend form/call

id
string

(auto) detected in frontend form/call

remapRoles
string

(auto) detected in frontend form/call

gdapRoles
string

(auto) detected in frontend form/call

ignoreMissingRoles
string

(auto) detected in frontend form/call

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "standardsExcludeAllTenants": "string",
  • "id": "string",
  • "remapRoles": "string",
  • "gdapRoles": "string",
  • "ignoreMissingRoles": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

SetAuthMethod

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
GroupIds
string
Id
string
state
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GroupIds": "string",
  • "Id": "string",
  • "state": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

CIPP > Setup

ExecAddTenant

Authorizations:
bearerAuth
Request Body schema: application/json
required
accessToken
string
defaultDomainName
string
tenantId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "accessToken": "string",
  • "defaultDomainName": "string",
  • "tenantId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCombinedSetup

Authorizations:
bearerAuth
Request Body schema: application/json
required
applicationId
string
applicationSecret
string
baselineOption
string
email
string
RefreshToken
string
selectedBaselines
string
selectedOption
string
tenantid
string
webhook
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "applicationId": "string",
  • "applicationSecret": "string",
  • "baselineOption": "string",
  • "email": "string",
  • "RefreshToken": "string",
  • "selectedBaselines": "string",
  • "selectedOption": "string",
  • "tenantid": "string",
  • "webhook": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecCreateSAMApp

Authorizations:
bearerAuth
Request Body schema: application/json
required
access_token
string

access_token parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

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

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecDeviceCodeLogon

Authorizations:
bearerAuth
query Parameters
clientId
string
deviceCode
string
operation
string
scope
string
tenantId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSAMSetup

Authorizations:
bearerAuth
query Parameters
CheckSetupProcess
string
code
string
count
string
CreateSAM
string
error
string
error_description
string
step
string
Request Body schema: application/json
required
applicationid
string
applicationsecret
string
RefreshToken
string
setkeys
string
tenantid
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "applicationid": "string",
  • "applicationsecret": "string",
  • "RefreshToken": "string",
  • "setkeys": "string",
  • "tenantid": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecTokenExchange

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantId
string
tokenRequest
string
tokenUrl
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "tokenRequest": "string",
  • "tokenUrl": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecUpdateRefreshToken

Authorizations:
bearerAuth
Request Body schema: application/json
required
refreshtoken
string
tenantId
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "refreshtoken": "string",
  • "tenantId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Security

ExecAlertsList

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecIncidentsList

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

EndDate
string
StartDate
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecMdoAlertsList

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMdoAlert

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Assigned
string
Classification
string
Determination
string
GUID
string
Status
string
Request Body schema: application/json
required
tenantFilter
required
string
Assigned
string
Classification
string
Determination
string
GUID
string
Status
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Assigned": "string",
  • "Classification": "string",
  • "Determination": "string",
  • "GUID": "string",
  • "Status": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetSecurityAlert

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

GUID
string
Provider
string
Status
string
Vendor
string
Request Body schema: application/json
required
tenantFilter
required
string
GUID
string
Provider
string
Status
string
Vendor
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "GUID": "string",
  • "Provider": "string",
  • "Status": "string",
  • "tenantFilter": "string",
  • "Vendor": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetSecurityIncident

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Assigned
string
Classification
string
Determination
string
GUID
string
Redirected
string
Status
string
Request Body schema: application/json
required
tenantFilter
required
string
Assigned
string
Classification
string
Determination
string
GUID
string
Redirected
string
Status
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Assigned": "string",
  • "Classification": "string",
  • "Determination": "string",
  • "GUID": "string",
  • "Redirected": "string",
  • "Status": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMDEOnboarding

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tools > GitHub

Make changes to a community repository

This function makes changes to a community repository in table storage .FUNCTIONALITY Entrypoint,AnyTenant .ROLE CIPP.Core.ReadWrite #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string

Action parameter

Branch
string

Branch parameter

Description
string

Description parameter

FullName
string

FullName parameter

GUID
string

GUID parameter

Id
string

Id parameter

includeforks
boolean

includeforks parameter

Message
string

Message parameter

object

orgName parameter

Path
string

Path parameter

object

policySource parameter

Private
boolean

Private parameter

repoName
string

repoName parameter

object

searchTerm parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Branch": "string",
  • "Description": "string",
  • "FullName": "string",
  • "GUID": "string",
  • "Id": "string",
  • "includeforks": true,
  • "Message": "string",
  • "orgName": {
    },
  • "Path": "string",
  • "policySource": {
    },
  • "Private": true,
  • "repoName": "string",
  • "searchTerm": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Invoke GitHub Action

Call GitHub API .ROLE CIPP.Extension.ReadWrite .FUNCTIONALITY Entrypoint,AnyTenant #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
Action
string

Action parameter

Request Body schema: application/json
required
Action
string

Action parameter

Description
string

Description parameter

includeforks
boolean

includeforks parameter

object

orgName parameter

object

policySource parameter

Private
boolean

Private parameter

repoName
string

repoName parameter

object

searchTerm parameter

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Description": "string",
  • "includeforks": true,
  • "orgName": {
    },
  • "policySource": {
    },
  • "Private": true,
  • "repoName": "string",
  • "searchTerm": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

List community repositories in Table Storage

This function lists community repositories in Table Storage .FUNCTIONALITY Entrypoint,AnyTenant .ROLE CIPP.Core.Read #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
WriteAccess
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Retrieves release notes for a GitHub repository.

Returns release metadata for the provided repository and semantic version. Hotfix versions (e.g. v8.5.2) map back to the base release tag (v8.5.0). .FUNCTIONALITY Entrypoint,AnyTenant .ROLE CIPP.Core.Read #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
query Parameters
Owner
string
Repository
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Identity > Administration > Devices

ExecDeviceDelete

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

action
string
ID
string
Request Body schema: application/json
required
tenantFilter
required
string
action
string
ID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "action": "string",
  • "ID": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

CIPP > Extensions

ExecExtensionClearHIBPKey

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExtensionMapping

Authorizations:
bearerAuth
query Parameters
AddMapping
string
AutoMapping
string
List
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExtensionSync

Authorizations:
bearerAuth
query Parameters
Extension
string
TenantID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExtensionTest

Authorizations:
bearerAuth
query Parameters
extensionName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecExtensionsConfig

Authorizations:
bearerAuth
Request Body schema: application/json
required
Hudu
string

Body parameter from PS1: Hudu

NinjaOne
string

Body parameter from PS1: NinjaOne

PSObject
string

Body parameter from PS1: PSObject

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Hudu": "string",
  • "NinjaOne": "string",
  • "PSObject": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExtensionSync

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tools

ExecGenerateReportBuilderReport

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

TemplateName
string
Request Body schema: application/json
required
TenantFilter
required
string
Action
string
Blocks
string
ReportGUID
string
TemplateGUID
string
TemplateName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Blocks": "string",
  • "ReportGUID": "string",
  • "TemplateGUID": "string",
  • "TemplateName": "string",
  • "TenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecReportBuilderTemplate

Authorizations:
bearerAuth
Request Body schema: application/json
required
Action
string
Blocks
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

GUID
string
includeRawAttachments
boolean
object
Array of objects (LabelValue)
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

removeRemediation
boolean
scheduleName
string
Array of objects (LabelValue)
templateName
string
object (LabelValue)

Autocomplete/select field. Most dropdowns in CIPP use this shape. Backend typically unwraps via: $x.value ?? $x

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Action": "string",
  • "Blocks": "string",
  • "blockType": {
    },
  • "dbCacheType": {
    },
  • "dbFormat": {
    },
  • "GUID": "string",
  • "includeRawAttachments": true,
  • "Name": {
    },
  • "postExecution": [
    ],
  • "recurrence": {
    },
  • "removeRemediation": true,
  • "scheduleName": "string",
  • "selectedTest": [
    ],
  • "templateName": "string",
  • "testSuite": {
    }
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGeneratedReports

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

ReportGUID
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListReportBuilderTemplates

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Tools

ExecMailTest

Authorizations:
bearerAuth
query Parameters
Action
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecMailboxRestore

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Action
string

Query param for Remove|Resume|Suspend actions on existing requests. Not sent by this form.

Identity
string

Existing restore request identity for Remove/Resume/Suspend. Not sent by this form.

Request Body schema: application/json
required
TenantFilter
required
string

Formatter sends as 'TenantFilter' (capital T). PS1 reads $Request.Body.TenantFilter.

RequestName
string

Auto-generated in form as 'Restore {source} to {target} ({uuid})'.

SourceMailbox
string

Formatter sends ExchangeGuid from addedFields if present, otherwise UPN. PS1 reads .value ?? raw value. NOTE: formatter pre-resolves to ExchangeGuid string, so PS1 receives the guid directly.

TargetMailbox
string

Same as SourceMailbox — ExchangeGuid or UPN string.

BadItemLimit
integer
LargeItemLimit
integer
AcceptLargeDataLoss
boolean
AssociatedMessagesCopyOption
string

Enum: DoNotCopy|MapByMessageClass|Copy. PS1 reads .value from the object.

ExcludeFolders
Array of strings

Array of folder specifiers e.g. '#Inbox#'. PS1 reads .value from array items.

IncludeFolders
Array of strings

Array of folder specifiers. PS1 reads .value from array items.

BatchName
string
CompletedRequestAgeLimit
integer
ConflictResolutionOption
string

Enum: ForceCopy|KeepAll|KeepLatestItem|KeepSourceItem|KeepTargetItem|UpdateFromSource. PS1 reads .value.

SourceRootFolder
string
TargetRootFolder
string
TargetType
string

Enum: Archive|MailboxLocation|Primary. PS1 reads .value.

ExcludeDumpster
boolean
SourceIsArchive
boolean
TargetIsArchive
boolean
Action
string

Body parameter from PS1: Action

Identity
string

Body parameter from PS1: Identity

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "TenantFilter": "string",
  • "RequestName": "string",
  • "SourceMailbox": "string",
  • "TargetMailbox": "string",
  • "BadItemLimit": 0,
  • "LargeItemLimit": 0,
  • "AcceptLargeDataLoss": true,
  • "AssociatedMessagesCopyOption": "string",
  • "ExcludeFolders": [
    ],
  • "IncludeFolders": [
    ],
  • "BatchName": "string",
  • "CompletedRequestAgeLimit": 0,
  • "ConflictResolutionOption": "string",
  • "SourceRootFolder": "string",
  • "TargetRootFolder": "string",
  • "TargetType": "string",
  • "ExcludeDumpster": true,
  • "SourceIsArchive": true,
  • "TargetIsArchive": true,
  • "Action": "string",
  • "Identity": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListExoRequest

Authorizations:
bearerAuth
Request Body schema: application/json
required
TenantFilter
required
string
Anchor
string
AsApp
boolean
AvailableCmdlets
string
Cmdlet
string
cmdParams
string
Compliance
boolean
Select
string
UseSystemMailbox
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Anchor": "string",
  • "AsApp": true,
  • "AvailableCmdlets": "string",
  • "Cmdlet": "string",
  • "cmdParams": "string",
  • "Compliance": true,
  • "Select": "string",
  • "TenantFilter": "string",
  • "UseSystemMailbox": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxRestores

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Identity
string
IncludeReport
string
Statistics
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMessageTrace

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string

tenantFilter parameter

dateFilter
string
Enum: "relative" "startEnd"

dateFilter parameter

days
number

days parameter

endDate
string <date-time>

endDate parameter

fromIP
string

fromIP parameter

ID
string

ID parameter

recipient
Array of strings

recipient parameter

sender
Array of strings

sender parameter

startDate
string <date-time>

startDate parameter

status
Array of strings

status parameter

toIP
string

toIP parameter

traceDetail
string

traceDetail parameter

MessageId
string

Body parameter from PS1: MessageId

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "dateFilter": "relative",
  • "days": 0,
  • "endDate": "2019-08-24T14:15:22Z",
  • "fromIP": "string",
  • "ID": "string",
  • "recipient": [
    ],
  • "sender": [
    ],
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": [
    ],
  • "tenantFilter": "string",
  • "toIP": "string",
  • "traceDetail": "string",
  • "MessageId": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Administration > Mailbox Retention

ExecManageRetentionPolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

name
string

Used for GET (single policy) requests.

Request Body schema: application/json
required
tenantFilter
required
string
CreatePolicies
Array of strings

Array of policy objects to create: [{Name: string, RetentionPolicyTagLinks: string[]}]. Sent when isEdit=false.

ModifyPolicies
Array of strings

Array of policy modification objects: [{Identity: string, Name: string, RetentionPolicyTagLinks: string[]}]. Sent when isEdit=true.

DeletePolicies
Array of strings

Array of policy identity strings to delete. Not sent by this form but accepted by PS1.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "tenantFilter": "string",
  • "CreatePolicies": [
    ],
  • "ModifyPolicies": [
    ],
  • "DeletePolicies": [
    ]
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecManageRetentionTags

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

name
string

Used for GET (single tag) requests.

Request Body schema: application/json
required
tenantFilter
required
string
Comment
string
CreateTags
Array of strings

Array of tag objects to create: [{Name, Type, Comment, RetentionAction, AgeLimitForRetention, RetentionEnabled, LocalizedComment, LocalizedRetentionPolicyTagName}]. Sent when isEdit=false.

ModifyTags
Array of strings

Array of tag modification objects: [{Identity: original name, Name?, Comment?, RetentionAction?, AgeLimitForRetention?, RetentionEnabled?, LocalizedComment?, LocalizedRetentionPolicyTagName?}]. Sent when isEdit=true.

DeleteTags
Array of strings

Array of tag identity strings to delete. Not sent by this form but accepted by PS1.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Comment": "string",
  • "tenantFilter": "string",
  • "CreateTags": [
    ],
  • "ModifyTags": [
    ],
  • "DeleteTags": [
    ]
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ExecSetMailboxRetentionPolicies

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Request Body schema: application/json
required
tenantFilter
required
string
Mailboxes
string
PolicyName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "Mailboxes": "string",
  • "PolicyName": "string",
  • "tenantFilter": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Identity

ExecSetCloudManaged

Sets the cloud-managed status of a user, group, or contact. #> [CmdletBinding()] param($Request, $TriggerMetadata)

Authorizations:
bearerAuth
Request Body schema: application/json
required
tenantFilter
required
string
displayName
string
ID
string
isCloudManaged
string
type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Request samples

Content type
application/json
{
  • "displayName": "string",
  • "ID": "string",
  • "isCloudManaged": "string",
  • "tenantFilter": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Email-Exchange > Reports

ListActiveSyncDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListAntiPhishingFilters

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListGlobalAddressList

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxCAS

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMailboxForwarding

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMalwareFilters

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSafeAttachmentsFilters

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSharedMailboxAccountEnabled

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Identity > Reports

ListAzureADConnectStatus

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

DataToReturn
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListBasicAuth

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListInactiveAccounts

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

InactiveDays
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListMFAUsers

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListSignIns

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Days
string
failedLogonsOnly
string
FailureThreshold
string
Filter
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Endpoint > Reports

ListDevices

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

Tenant > Reports

ListGraphReports

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

period
string
report
string
type
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListLicenses

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListOAuthApps

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

UseReportDB
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}

ListServiceHealth

Authorizations:
bearerAuth
query Parameters
tenantFilter
required
string

Target tenant domain or 'AllTenants' for multi-tenant operations.

defaultDomainName
string
displayName
string

Responses

Response Schema: application/json
Results
Array of strings

Result messages, one per operation. Mix of success and error strings.

Response samples

Content type
application/json
{
  • "Results": [
    ]
}