Get CIPPJoin Discord

Intune

List Applications

get

Retrieves a list of applications

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Applications retrieved successfully

application/json
get
GET /api/ListApps HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "publishingState": "text",
    "installCommandLine": "text",
    "uninstallCommandLine": "text"
  }
]

Assign Application

post

Assigns an application to users or devices

Body
AssignTostring · enumRequired

Who to assign the application to

Possible values:
IDstringRequired

The application ID

customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses
200

Application assigned successfully

application/json
post
POST /api/ExecAssignApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "AssignTo": "AllUsers",
  "ID": "text",
  "customGroup": "text"
}
{
  "Results": {}
}

Remove Application

post

Removes an application

Body
IDstringRequired

The application ID

Responses
200

Application removed successfully

application/json
post
POST /api/RemoveApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

List Application Queue

get

Retrieves a list of applications in the queue

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Application queue retrieved successfully

application/json
get
GET /api/ListApplicationQueue HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "applicationName": "text",
    "status": "text"
  }
]

Remove Queued Application

post

Removes an application from the queue

Body
IDstringRequired

The queue item ID

Responses
200

Queued application removed successfully

application/json
post
POST /api/RemoveQueuedApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

Execute Application Upload

post

Executes the application upload process

Responses
200

Application upload executed successfully

application/json
post
POST /api/ExecAppUpload HTTP/1.1
Host: 
Accept: */*

{
  "Results": {}
}

Add MSP Application

post

Adds an MSP vendor application

Body
displayNamestringRequired

The display name of the application

paramsobjectOptional

Parameters specific to the RMM tool

AssignTostring · enumOptional

Who to assign the application to

Possible values:
customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses
200

MSP application added successfully

application/json
post
POST /api/AddMSPApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "rmmname": {
    "value": "datto"
  },
  "displayName": "text",
  "params": {},
  "AssignTo": "On",
  "customGroup": "text"
}
{
  "Results": {}
}

Add Store Application

post

Adds a store application

Body
packagenamestringRequired

The package identifier

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:
customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses
200

Store application added successfully

application/json
post
POST /api/AddStoreApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}
{
  "Results": {}
}

Add WinGet Application

post

Adds a WinGet application

Body
packagenamestringRequired

The package identifier

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:
customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses
200

WinGet application added successfully

application/json
post
POST /api/AddwinGetApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}
{
  "Results": {}
}

Add Chocolatey Application

post

Adds a Chocolatey application

Body
packagenamestringRequired

The package name

applicationNamestringRequired

The application name

descriptionstringOptional

The application description

customRepostringOptional

Custom repository URL

InstallAsSystembooleanOptional

Whether to install as system

DisableRestartbooleanOptional

Whether to disable restart

InstallationIntentbooleanOptional

Whether to mark for uninstallation

AssignTostring · enumOptional

Who to assign the application to

Possible values:
customGroupstringOptional

Custom group names (if AssignTo is customGroup)

Responses
200

Chocolatey application added successfully

application/json
post
POST /api/AddChocoApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "packagename": "text",
  "applicationName": "text",
  "description": "text",
  "customRepo": "text",
  "InstallAsSystem": true,
  "DisableRestart": true,
  "InstallationIntent": true,
  "AssignTo": "On",
  "customGroup": "text"
}
{
  "Results": {}
}

Add Office Application

post

Adds a Microsoft Office application

Body
SharedComputerActivationbooleanOptional

Whether to use shared computer activation

archbooleanOptional

Whether to use 64-bit

RemoveVersionsbooleanOptional

Whether to remove other versions

AcceptLicensebooleanOptional

Whether to accept the license

AssignTostring · enumOptional

Who to assign the application to

Possible values:
Responses
200

Office application added successfully

application/json
post
POST /api/AddOfficeApp HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 276

{
  "selectedTenants": [
    {
      "defaultDomainName": "text",
      "customerId": "text"
    }
  ],
  "excludedApps": [
    {
      "value": "access"
    }
  ],
  "updateChannel": {
    "value": "current"
  },
  "languages": [
    {
      "value": "text"
    }
  ],
  "SharedComputerActivation": true,
  "arch": true,
  "RemoveVersions": true,
  "AcceptLicense": true,
  "AssignTo": "On"
}
{
  "Results": {}
}

List Autopilot Devices

get

Retrieves a list of Autopilot devices

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Autopilot devices retrieved successfully

application/json
get
GET /api/ListAPDevices HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "serialNumber": "text",
    "model": "text",
    "manufacturer": "text",
    "groupTag": "text",
    "enrollmentState": "text"
  }
]

Assign Autopilot Device

post

Assigns an Autopilot device to a user

Body
devicestringRequired

The device ID

serialNumberstringRequired

The serial number of the device

userstringRequired

The user principal name

Responses
200

Autopilot device assigned successfully

application/json
post
POST /api/ExecAssignAPDevice HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "device": "text",
  "serialNumber": "text",
  "user": "text"
}
{
  "Results": {}
}

Remove Autopilot Device

post

Removes an Autopilot device

Body
IDstringRequired

The device ID

Responses
200

Autopilot device removed successfully

application/json
post
POST /api/RemoveAPDevice HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

Sync Autopilot Devices

post

Syncs Autopilot devices

Responses
200

Autopilot devices synced successfully

application/json
post
POST /api/ExecSyncAPDevices HTTP/1.1
Host: 
Accept: */*

{
  "Results": {}
}

List Autopilot Configurations

get

Retrieves a list of Autopilot configurations

Query parameters
typestring · enumOptional

The type of configuration to retrieve

Possible values:
tenantFilterstringOptional

The tenant to filter by

Responses
200

Autopilot configurations retrieved successfully

application/json
get
GET /api/ListAutopilotConfig HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

List Devices

get

Retrieves a list of devices

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Devices retrieved successfully

application/json
get
GET /api/ListDevices HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "manufacturer": "text",
    "model": "text",
    "osVersion": "text",
    "lastSyncDateTime": "text"
  }
]

Execute Device Action

post

Executes an action on a device

Body
Actionstring · enumRequired

The action to perform

Possible values:
DeviceIDstringRequired

The device ID

NewDeviceNamestringOptional

The new device name (for Rename action)

Responses
200

Device action executed successfully

application/json
post
POST /api/ExecDeviceAction HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "Action": "Reboot",
  "DeviceID": "text",
  "NewDeviceName": "text"
}
{
  "Results": {}
}

Get Local Admin Password

post

Retrieves the local admin password for a device

Body
DeviceIDstringRequired

The device ID

Responses
200

Local admin password retrieved successfully

application/json
post
POST /api/ExecGetLocalAdminPassword HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "DeviceID": "text"
}
{
  "Results": {}
}

Get Recovery Key

post

Retrieves the recovery key for a device

Body
DeviceIDstringRequired

The device ID

Responses
200

Recovery key retrieved successfully

application/json
post
POST /api/ExecGetRecoveryKey HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "DeviceID": "text"
}
{
  "Results": {}
}

List Intune Policies

get

Retrieves a list of Intune policies

Query parameters
typestring · enumOptional

The type of policy to retrieve

Possible values:
tenantFilterstringOptional

The tenant to filter by

Responses
200

Intune policies retrieved successfully

application/json
get
GET /api/ListIntunePolicy HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

Add Policy

post

Adds a policy

Body
Responses
200

Policy added successfully

application/json
post
POST /api/AddPolicy HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "selectedTenants": [
    {
      "customerId": "text"
    }
  ]
}
{
  "Results": {}
}

Add Intune Template

post

Adds an Intune template

Body
TypestringOptional

The type of template

Responses
200

Intune template added successfully

application/json
post
POST /api/AddIntuneTemplate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "Type": "text"
}
{
  "Results": {}
}

Assign Policy

post

Assigns a policy

Body
AssignTostring · enumRequired

Who to assign the policy to

Possible values:
IDstringRequired

The policy ID

Responses
200

Policy assigned successfully

application/json
post
POST /api/ExecAssignPolicy HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "AssignTo": "AllUsers",
  "ID": "text"
}
{
  "Results": {}
}

Remove Policy

post

Removes a policy

Body
IDstringRequired

The policy ID

Responses
200

Policy removed successfully

application/json
post
POST /api/RemovePolicy HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

List Intune Templates

get

Retrieves a list of Intune templates

Query parameters
ViewbooleanOptional

Whether to view the templates

tenantFilterstringOptional

The tenant to filter by

Responses
200

Intune templates retrieved successfully

application/json
get
GET /api/ListIntuneTemplates HTTP/1.1
Host: 
Accept: */*

[
  {
    "GUID": "text",
    "displayName": "text"
  }
]

Edit Template

post

Edits a template

Body
GUIDstringOptional

The template ID

Responses
200

Template edited successfully

application/json
post
POST /api/ExecEditTemplate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "GUID": "text"
}
{
  "Results": {}
}

Execute Community Repository

post

Executes a community repository

Body
RepoURLstringOptional

The repository URL

Responses
200

Community repository executed successfully

application/json
post
POST /api/ExecCommunityRepo HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "RepoURL": "text"
}
{
  "Results": {}
}

Remove Intune Template

post

Removes an Intune template

Body
IDstringRequired

The template ID

Responses
200

Intune template removed successfully

application/json
post
POST /api/RemoveIntuneTemplate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

List Intune Scripts

get

Retrieves a list of Intune scripts

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Intune scripts retrieved successfully

application/json
get
GET /api/ListIntuneScript HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "displayName": "text"
  }
]

Remove Intune Script

post

Removes an Intune script

Body
IDstringRequired

The script ID

Responses
200

Intune script removed successfully

application/json
post
POST /api/RemoveIntuneScript HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}
{
  "Results": {}
}

List Graph Request

get

Retrieves data from a Graph API request

Query parameters
tenantFilterstringOptional

The tenant to filter by

endpointstringOptional

The Graph API endpoint

Responses
200

Graph request data retrieved successfully

application/json
get
GET /api/ListGraphRequest HTTP/1.1
Host: 
Accept: */*

{
  "Results": [
    {}
  ]
}

List Users

get

Retrieves a list of users

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Users retrieved successfully

application/json
get
GET /api/listUsers HTTP/1.1
Host: 
Accept: */*

[
  {
    "userPrincipalName": "text",
    "displayName": "text"
  }
]

List Apps Repository

post

Searches the apps repository

Body
searchstringRequired

The search query

Responses
200

Apps repository search results retrieved successfully

application/json
post
POST /api/ListAppsRepository HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "search": "text"
}
{
  "Results": [
    {
      "packagename": "text",
      "applicationName": "text",
      "description": "text"
    }
  ]
}

List Potential Apps

post

Searches for potential apps

Body
searchStringstringRequired

The search query

typestring · enumRequired

The type of apps to search for

Possible values:
Responses
200

Potential apps search results retrieved successfully

application/json
post
POST /api/ListPotentialApps HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "searchString": "text",
  "type": "WinGet"
}
{
  "data": [
    {
      "packagename": "text",
      "applicationName": "text",
      "description": "text"
    }
  ]
}

List Extensions Configuration

get

Retrieves the configuration for extensions

Responses
200

Extensions configuration retrieved successfully

application/json
get
GET /api/ListExtensionsConfig HTTP/1.1
Host: 
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {
    "Enabled": true
  }
}

List Community Repositories

get

Retrieves a list of community repositories

Query parameters
tenantFilterstringOptional

The tenant to filter by

Responses
200

Community repositories retrieved successfully

application/json
get
GET /api/ListCommunityRepos HTTP/1.1
Host: 
Accept: */*

[
  {
    "RepoURL": "text",
    "RepoName": "text"
  }
]
PreviousSecurity & ComplianceNextTeams & SharePoint

Last updated

Was this helpful?