Tenant Administration

List Alerts Queue

get

Retrieves a list of alerts in the queue

Responses

200

Alerts retrieved successfully

application/json

RowKeystringOptional

Unique identifier for the alert

PartitionKeystringOptional

Partition key for the alert

LogTypestringOptional

Type of log

RawAlertobjectOptional

Raw alert data

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListAlertsQueue

HTTPcURLJavaScriptPython

GET /api/ListAlertsQueue HTTP/1.1
Accept: */*

[
  {
    "RowKey": "text",
    "PartitionKey": "text",
    "LogType": "text",
    "RawAlert": {}
  }
]

Add Alert

post

Adds a new alert

Body

application/json

Responses

200

Alert added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddAlert

HTTPcURLJavaScriptPython

POST /api/AddAlert HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "tenantFilter": [
    {
      "value": "text",
      "label": "text"
    }
  ],
  "excludedTenants": [
    {
      "value": "text",
      "label": "text"
    }
  ],
  "logbook": {
    "value": "text",
    "label": "text"
  },
  "conditions": [
    {
      "Property": {
        "value": "text",
        "label": "text"
      },
      "Operator": {
        "value": "text",
        "label": "text"
      },
      "Input": {
        "value": "text"
      }
    }
  ],
  "Actions": [
    {
      "value": "text",
      "label": "text"
    }
  ]
}

{
  "Results": {}
}

Add Scheduled Item

post

Adds a new scheduled item

Query parameters

hiddenbooleanOptional

Whether to hide the scheduled item

DisallowDuplicateNamebooleanOptional

Whether to disallow duplicate names

Body

application/json

RowKeystringOptional

Unique identifier for the scheduled item

tenantFilterstringOptional

Tenant to apply the scheduled item to

NamestringOptional

Name of the scheduled item

ParametersobjectOptional

Parameters for the command

ScheduledTimeintegerOptional

When the job is scheduled to run (Unix timestamp)

RecurrencestringOptional

How often the job recurs

Responses

200

Scheduled item added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddScheduledItem

HTTPcURLJavaScriptPython

POST /api/AddScheduledItem HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "RowKey": "text",
  "tenantFilter": "text",
  "excludedTenants": [
    {
      "value": "text",
      "label": "text"
    }
  ],
  "Name": "text",
  "Command": {
    "value": "text"
  },
  "Parameters": {},
  "ScheduledTime": 1,
  "Recurrence": "text",
  "PostExecution": [
    {
      "value": "text",
      "label": "text"
    }
  ]
}

{
  "Results": {}
}

List CSP Licenses

get

Retrieves a list of CSP licenses

Responses

200

CSP licenses retrieved successfully

application/json

TenantstringOptional

Tenant name

TenantIdstringOptional

Tenant ID

SubscriptionIdstringOptional

Subscription ID

SkuIdstringOptional

SKU ID

SkuNamestringOptional

SKU name

StatusstringOptional

Subscription status

QuantityintegerOptional

License quantity

BillingCyclestringOptional

Billing cycle

RenewalDatestringOptional

Renewal date

400

Bad request

401

Unauthorized

500

Internal server error

get

/listCSPLicenses

HTTPcURLJavaScriptPython

GET /api/listCSPLicenses HTTP/1.1
Accept: */*

[
  {
    "Tenant": "text",
    "TenantId": "text",
    "SubscriptionId": "text",
    "SkuId": "text",
    "SkuName": "text",
    "Status": "text",
    "Quantity": 1,
    "BillingCycle": "text",
    "RenewalDate": "text"
  }
]

Execute CSP License Operation

post

Executes an operation on CSP licenses

Body

application/json

Actionstring · enumOptional

Action to perform

Possible values:

skustringOptional

SKU ID

addintegerOptional

Number of licenses to add

RemoveintegerOptional

Number of licenses to remove

SubscriptionIdsstringOptional

Subscription IDs to cancel

Responses

200

CSP license operation executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecCSPLicense

HTTPcURLJavaScriptPython

POST /api/ExecCSPLicense HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "Action": "!Add",
  "sku": "text",
  "add": 1,
  "Remove": 1,
  "SubscriptionIds": "text"
}

{
  "Results": {}
}

List Licenses

get

Retrieves a list of licenses

Responses

200

Licenses retrieved successfully

application/json

TenantstringOptional

Tenant name

LicensestringOptional

License name

CountUsedintegerOptional

Number of licenses used

CountAvailableintegerOptional

Number of licenses available

TotalLicensesintegerOptional

Total number of licenses

TermInfoobjectOptional

Term information

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListLicenses

HTTPcURLJavaScriptPython

GET /api/ListLicenses HTTP/1.1
Accept: */*

[
  {
    "Tenant": "text",
    "License": "text",
    "CountUsed": 1,
    "CountAvailable": 1,
    "TotalLicenses": 1,
    "TermInfo": {}
  }
]

List Standards

get

Retrieves a list of standards

Responses

200

Standards retrieved successfully

application/json

RowKeystringOptional

Unique identifier for the standard

StandardstringOptional

Standard name

TenantstringOptional

Tenant name

EnabledbooleanOptional

Whether the standard is enabled

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListStandards

HTTPcURLJavaScriptPython

GET /api/ListStandards HTTP/1.1
Accept: */*

[
  {
    "RowKey": "text",
    "Standard": "text",
    "Tenant": "text",
    "Enabled": true
  }
]

List Standard Templates

get

Retrieves a list of standard templates

Responses

200

Standard templates retrieved successfully

application/json

GUIDstringOptional

Unique identifier for the template

templateNamestringOptional

Template name

updatedAtstringOptional

When the template was last updated

updatedBystringOptional

Who last updated the template

runManuallybooleanOptional

Whether the template is run manually

standardsobject[]Optional

List of standards in the template

400

Bad request

401

Unauthorized

500

Internal server error

get

/listStandardTemplates

HTTPcURLJavaScriptPython

GET /api/listStandardTemplates HTTP/1.1
Accept: */*

[
  {
    "GUID": "text",
    "templateName": "text",
    "tenantFilter": [
      {
        "value": "text",
        "label": "text"
      }
    ],
    "excludedTenants": [
      {
        "value": "text",
        "label": "text"
      }
    ],
    "updatedAt": "text",
    "updatedBy": "text",
    "runManually": true,
    "standards": [
      {}
    ]
  }
]

Execute Standards Run

get

Executes a standards run

Query parameters

TemplateIdstringRequired

Template ID to run

tenantFilterstringOptional

Tenant filter

Responses

200

Standards run executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

get

/ExecStandardsRun

HTTPcURLJavaScriptPython

GET /api/ExecStandardsRun?TemplateId=text HTTP/1.1
Accept: */*

{
  "Results": {}
}

Remove Standard Template

post

Removes a standard template

Body

application/json

IDstringRequired

Template ID to remove

Responses

200

Standard template removed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/RemoveStandardTemplate

HTTPcURLJavaScriptPython

POST /api/RemoveStandardTemplate HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "ID": "text"
}

{
  "Results": {}
}

Convert Standards

post

Converts legacy standards to the new format

Responses

200

Standards converted successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/execStandardConvert

HTTPcURLJavaScriptPython

POST /api/execStandardConvert HTTP/1.1
Accept: */*

{
  "Results": {}
}

List Named Locations

get

Retrieves a list of named locations

Responses

200

Named locations retrieved successfully

application/json

idstringOptional

Unique identifier for the named location

displayNamestringOptional

Display name

@odata.typestringOptional

Type of named location

includeUnknownCountriesAndRegionsbooleanOptional

Whether to include unknown countries and regions

isTrustedbooleanOptional

Whether the location is trusted

rangeOrLocationstringOptional

Range or location

modifiedDateTimestringOptional

When the named location was last modified

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListNamedLocations

HTTPcURLJavaScriptPython

GET /api/ListNamedLocations HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "@odata.type": "text",
    "includeUnknownCountriesAndRegions": true,
    "isTrusted": true,
    "rangeOrLocation": "text",
    "modifiedDateTime": "text"
  }
]

Execute Named Location Operation

post

Executes an operation on a named location

Body

application/json

namedLocationIdstringRequired

Named location ID

changestring · enumRequired

Change to make

Possible values:

inputstringRequired

Input value (country code or IP)

Responses

200

Named location operation executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecNamedLocation

HTTPcURLJavaScriptPython

POST /api/ExecNamedLocation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "namedLocationId": "text",
  "change": "addLocation",
  "input": "text"
}

{
  "Results": {}
}

Add Named Location

post

Adds a new named location

Body

application/json

displayNamestringOptional

Display name

locationTypestring · enumOptional

Type of location

Possible values:

countriesAndRegionsstring[]Optional

List of countries and regions

includeUnknownCountriesAndRegionsbooleanOptional

Whether to include unknown countries and regions

isTrustedbooleanOptional

Whether the location is trusted

Responses

200

Named location added successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/AddNamedLocation

HTTPcURLJavaScriptPython

POST /api/AddNamedLocation HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "displayName": "text",
  "locationType": "country",
  "countriesAndRegions": [
    "text"
  ],
  "includeUnknownCountriesAndRegions": true,
  "ipRanges": [
    {
      "cidrAddress": "text"
    }
  ],
  "isTrusted": true
}

{
  "Results": {}
}

List Conditional Access Policies

get

Retrieves a list of conditional access policies

Responses

200

Conditional access policies retrieved successfully

application/json

idstringOptional

Unique identifier for the policy

displayNamestringOptional

Display name

statestringOptional

State of the policy

conditionsobjectOptional

Conditions for the policy

grantControlsobjectOptional

Grant controls for the policy

sessionControlsobjectOptional

Session controls for the policy

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListConditionalAccessPolicies

HTTPcURLJavaScriptPython

GET /api/ListConditionalAccessPolicies HTTP/1.1
Accept: */*

[
  {
    "id": "text",
    "displayName": "text",
    "state": "text",
    "conditions": {},
    "grantControls": {},
    "sessionControls": {}
  }
]

Execute Conditional Access Exclusion

post

Executes a conditional access exclusion

Body

application/json

startDatestringOptional

Start date for the exclusion

endDatestringOptional

End date for the exclusion

Responses

200

Conditional access exclusion executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecCAExclusion

HTTPcURLJavaScriptPython

POST /api/ExecCAExclusion HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "tenantFilter": {
    "value": "text",
    "label": "text"
  },
  "user": {
    "value": "text",
    "label": "text"
  },
  "policy": {
    "value": "text",
    "label": "text"
  },
  "startDate": "text",
  "endDate": "text"
}

{
  "Results": {}
}

List Graph Request

get

Retrieves data from Microsoft Graph API

Query parameters

EndpointstringRequired

Graph API endpoint

$selectstringOptional

Fields to select

$countbooleanOptional

Whether to include count

$topintegerOptional

Number of results to return

Responses

200

Graph request executed successfully

application/json

Resultsobject[]Optional

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListGraphRequest

HTTPcURLJavaScriptPython

GET /api/ListGraphRequest?Endpoint=text HTTP/1.1
Accept: */*

{
  "Results": [
    {}
  ]
}

List Audit Logs

get

Retrieves a list of audit logs

Query parameters

RelativeTimestringOptional

Relative time filter

StartDatestring · dateOptional

Start date filter

EndDatestring · dateOptional

End date filter

Responses

200

Audit logs retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListAuditLogs

HTTPcURLJavaScriptPython

GET /api/ListAuditLogs HTTP/1.1
Accept: */*

{
  "Results": [
    {
      "Timestamp": "text",
      "Tenant": "text",
      "Title": "text",
      "LogId": "text",
      "Actions": "text"
    }
  ]
}

List Backups

get

Retrieves a list of backups

Query parameters

tenantFilterstringOptional

Tenant filter

Responses

200

Backups retrieved successfully

application/json

BackupNamestringOptional

Name of the backup

TimestampstringOptional

When the backup was created

BackupstringOptional

The backup data (JSON string)

400

Bad request

401

Unauthorized

500

Internal server error

get

/ExecListBackup

HTTPcURLJavaScriptPython

GET /api/ExecListBackup HTTP/1.1
Accept: */*

[
  {
    "BackupName": "text",
    "Timestamp": "text",
    "Backup": "text"
  }
]

List CSP SKUs

get

Retrieves a list of CSP SKUs

Responses

200

CSP SKUs retrieved successfully

application/json

skustringOptional

SKU ID

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListCSPsku

HTTPcURLJavaScriptPython

GET /api/ListCSPsku HTTP/1.1
Accept: */*

[
  {
    "sku": "text",
    "name": [
      {
        "value": "text"
      }
    ]
  }
]

List Community Repositories

get

Retrieves a list of community repositories

Query parameters

WriteAccessbooleanOptional

Whether to only include repositories with write access

Responses

200

Community repositories retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListCommunityRepos

HTTPcURLJavaScriptPython

GET /api/ListCommunityRepos HTTP/1.1
Accept: */*

{
  "Results": [
    {
      "FullName": "text"
    }
  ]
}

Execute Community Repository Operation

post

Executes an operation on a community repository

Body

application/json

Actionstring · enumRequired

Action to perform

Possible values:

GUIDstringRequired

Template GUID

FullNamestringRequired

Repository full name

MessagestringRequired

Commit message

Responses

200

Community repository operation executed successfully

application/json

ResultsobjectOptional

The results of the operation

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecCommunityRepo

HTTPcURLJavaScriptPython

POST /api/ExecCommunityRepo HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "Action": "UploadTemplate",
  "GUID": "text",
  "FullName": "text",
  "Message": "text"
}

{
  "Results": {}
}

List Extensions Configuration

get

Retrieves the configuration for extensions

Responses

200

Extensions configuration retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListExtensionsConfig

HTTPcURLJavaScriptPython

GET /api/ListExtensionsConfig HTTP/1.1
Accept: */*

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

List GDAP Role Templates

get

Retrieves a list of existing GDAP role templates

Responses

200

GDAP role templates retrieved successfully

application/json

400

Bad request

401

Unauthorized

500

Internal server error

get

/ExecGDAPRoleTemplate

HTTPcURLJavaScriptPython

GET /api/ExecGDAPRoleTemplate HTTP/1.1
Accept: */*

{
  "Results": [
    {
      "TemplateId": "text",
      "RoleMappings": [
        {
          "GroupName": "text",
          "GroupId": "text",
          "RoleName": "text",
          "roleDefinitionId": "text"
        }
      ]
    }
  ],
  "Metadata": {
    "Count": 1
  }
}

List GDAP Roles

get

Retrieves a list of GDAP roles that have been mapped in CIPP

Responses

200

GDAP roles retrieved successfully

application/json

GroupNamestringOptional

Name of the GDAP group

GroupIdstringOptional

Unique identifier for the GDAP group

RoleNamestringOptional

Name of the Microsoft role

roleDefinitionIdstringOptional

Unique identifier for the role definition

400

Bad request

401

Unauthorized

500

Internal server error

get

/ListGDAPRoles

HTTPcURLJavaScriptPython

GET /api/ListGDAPRoles HTTP/1.1
Accept: */*

[
  {
    "GroupName": "text",
    "GroupId": "text",
    "RoleName": "text",
    "roleDefinitionId": "text"
  }
]

Create GDAP Invite

post

Creates a GDAP invite using the specified role mappings

Body

application/json

Responses

200

GDAP invite created successfully

application/json

MessagestringOptional

Success message

400

Bad request

401

Unauthorized

500

Internal server error

post

/ExecGDAPInvite

HTTPcURLJavaScriptPython

POST /api/ExecGDAPInvite HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "roleMappings": [
    {
      "GroupName": "text",
      "GroupId": "text",
      "RoleName": "text",
      "roleDefinitionId": "text"
    }
  ]
}

{
  "Message": "text",
  "Invite": {
    "PartitionKey": "text",
    "RowKey": "text",
    "InviteUrl": "text",
    "OnboardingUrl": "text",
    "RoleMappings": "text"
  }
}