{ "externalDocs": { "url": "https://cipp.app", "description": "CIPP Documentation" }, "info": { "version": "1.0.1", "description": "CIPP-API is an Azure Function App operating as the logic layer for the CIPP platform. It is composed primarily of standard Azure Functions with a handful of Azure Durable Functions handling more complex actions (mostly applying standards and running tenant analysis). API documentation is primarily intended to aid in further development of the CIPP platform. This API will most likely be out-dated and we request users to help us keep this up to date.", "title": "CIPP-API Documentation" }, "paths": { "/AddGroup": { "post": { "description": "AddGroup", "summary": "AddGroup", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "selectedTenants", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddChocoApp": { "post": { "description": "AddChocoApp", "summary": "AddChocoApp", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "InstallationIntent", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AssignTo", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveUser": { "get": { "description": "RemoveUser", "summary": "RemoveUser", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTeams": { "get": { "description": "ListTeams", "summary": "ListTeams", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGroupsDelete": { "get": { "description": "ExecGroupsDelete", "summary": "ExecGroupsDelete", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "GroupType", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "displayName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListRoles": { "get": { "description": "ListRoles", "summary": "ListRoles", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserMailboxRules": { "get": { "description": "ListUserMailboxRules", "summary": "ListUserMailboxRules", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecBECCheck": { "get": { "description": "ExecBECCheck", "summary": "ExecBECCheck", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "userid", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListCalendarPermissions": { "get": { "description": "ListCalendarPermissions", "summary": "ListCalendarPermissions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAddSPN": { "get": { "description": "ExecAddSPN", "summary": "ExecAddSPN", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Enable", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListLicenses": { "get": { "description": "ListLicenses", "summary": "ListLicenses", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddCATemplate": { "post": { "description": "AddCATemplate", "summary": "AddCATemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "rawjson", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "name", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecIncidentsList": { "get": { "description": "ExecIncidentsList", "summary": "ExecIncidentsList", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddSharedMailbox": { "post": { "description": "AddSharedMailbox", "summary": "AddSharedMailbox", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListApps": { "get": { "description": "ListApps", "summary": "ListApps", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSharepointSettings": { "get": { "description": "ListSharepointSettings", "summary": "ListSharepointSettings", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "usertoGet", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "user", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSendOrgMessage": { "get": { "description": "ExecSendOrgMessage", "summary": "ExecSendOrgMessage", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "URL", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "freq", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddSpamFilterTemplate": { "post": { "description": "AddSpamFilterTemplate", "summary": "AddSpamFilterTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "PowerShellCommand", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "name", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListGroupTemplates": { "get": { "description": "ListGroupTemplates", "summary": "ListGroupTemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAutopilotconfig": { "get": { "description": "ListAutopilotconfig", "summary": "ListAutopilotconfig", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSetSecurityIncident": { "get": { "description": "ExecSetSecurityIncident", "summary": "ExecSetSecurityIncident", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Redirected", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Determination", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Status", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Classification", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Assigned", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditExConnector": { "get": { "description": "EditExConnector", "summary": "EditExConnector", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "state", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddUser": { "post": { "description": "AddUser", "summary": "AddUser", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "CopyFrom", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserPhoto": { "get": { "description": "ListUserPhoto", "summary": "ListUserPhoto", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListConditionalAccessPolicies": { "get": { "description": "ListConditionalAccessPolicies", "summary": "ListConditionalAccessPolicies", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListBasicAuth": { "get": { "description": "ListBasicAuth", "summary": "ListBasicAuth", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveSpamfilterTemplate": { "get": { "description": "RemoveSpamfilterTemplate", "summary": "RemoveSpamfilterTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGDAPInvite": { "post": { "description": "ExecGDAPInvite", "summary": "ExecGDAPInvite", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "gdapRoles", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserSigninLogs": { "get": { "description": "ListUserSigninLogs", "summary": "ListUserSigninLogs", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditCAPolicy": { "get": { "description": "EditCAPolicy", "summary": "EditCAPolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "state", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDomainHealth": { "get": { "description": "ListDomainHealth", "summary": "ListDomainHealth", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Action", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Record", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ExpectedInclude", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Domain", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Subdomains", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Selector", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecUniversalSearch": { "get": { "description": "ExecUniversalSearch", "summary": "ExecUniversalSearch", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "name", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMailboxCAS": { "get": { "description": "ListMailboxCAS", "summary": "ListMailboxCAS", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveExConnectorTemplate": { "get": { "description": "RemoveExConnectorTemplate", "summary": "RemoveExConnectorTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserCounts": { "get": { "description": "ListUserCounts", "summary": "ListUserCounts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGetLocalAdminPassword": { "get": { "description": "ExecGetLocalAdminPassword", "summary": "ExecGetLocalAdminPassword", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListOrg": { "get": { "description": "ListOrg", "summary": "ListOrg", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecExcludeLicenses": { "post": { "description": "ExecExcludeLicenses", "summary": "ExecExcludeLicenses", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "SKUName", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AddExclusion", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveExclusion", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecExcludeLicenses", "summary": "ExecExcludeLicenses", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "SKUName", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AddExclusion", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveExclusion", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecDeleteGDAPRelationship": { "get": { "description": "ExecDeleteGDAPRelationship", "summary": "ExecDeleteGDAPRelationship", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "GDAPId", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddMSPApp": { "post": { "description": "AddMSPApp", "summary": "AddMSPApp", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "selectedTenants", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AssignTo", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditPolicy": { "post": { "description": "EditPolicy", "summary": "EditPolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Assignto", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "groupid", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecDeviceAction": { "post": { "description": "ExecDeviceAction", "summary": "ExecDeviceAction", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "input", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Action", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecDeviceAction", "summary": "ExecDeviceAction", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "input", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Action", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddWinGetApp": { "post": { "description": "AddWinGetApp", "summary": "AddWinGetApp", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "InstallationIntent", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AssignTo", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemovePolicy": { "get": { "description": "RemovePolicy", "summary": "RemovePolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "URLName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddExConnector": { "post": { "description": "AddExConnector", "summary": "AddExConnector", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "PowerShellCommand", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTeamsVoice": { "get": { "description": "ListTeamsVoice", "summary": "ListTeamsVoice", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTeamsActivity": { "get": { "description": "ListTeamsActivity", "summary": "ListTeamsActivity", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSpamFilterTemplates": { "get": { "description": "ListSpamFilterTemplates", "summary": "ListSpamFilterTemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecCopyForSent": { "get": { "description": "ExecCopyForSent", "summary": "ExecCopyForSent", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "MessageCopyForSentAsEnabled", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAzureADConnectStatus": { "get": { "description": "ListAzureADConnectStatus", "summary": "ListAzureADConnectStatus", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DataToReturn", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecEnableArchive": { "get": { "description": "ExecEnableArchive", "summary": "ExecEnableArchive", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGetRecoveryKey": { "get": { "description": "ExecGetRecoveryKey", "summary": "ExecGetRecoveryKey", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSharedMailboxStatistics": { "get": { "description": "ListSharedMailboxStatistics", "summary": "ListSharedMailboxStatistics", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListPotentialApps": { "post": { "description": "ListPotentialApps", "summary": "ListPotentialApps", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "type", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "SearchString", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecCPVPermissions": { "get": { "description": "ExecCPVPermissions", "summary": "ExecCPVPermissions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSharepointQuota": { "get": { "description": "ListSharepointQuota", "summary": "ListSharepointQuota", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDefenderTVM": { "get": { "description": "ListDefenderTVM", "summary": "ListDefenderTVM", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecEditMailboxPermissions": { "post": { "description": "ExecEditMailboxPermissions", "summary": "ExecEditMailboxPermissions", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "AddSendAs", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "userID", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AddFullAccess", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AccessAutomap", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AddFullAccessNoAutoMap", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveFullAccess", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveSendAs", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddOfficeApp": { "post": { "description": "AddOfficeApp", "summary": "AddOfficeApp", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "AcceptLicense", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "languages", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "SharedComputerActivation", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "updateChannel", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "excludedApps", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "arch", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Assignto", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveVersions", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditSpamFilter": { "get": { "description": "EditSpamFilter", "summary": "EditSpamFilter", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "name", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "state", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSignIns": { "get": { "description": "ListSignIns", "summary": "ListSignIns", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "failedlogonOnly", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Filter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecDnsConfig": { "get": { "description": "ExecDnsConfig", "summary": "ExecDnsConfig", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Action", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Resolver", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Domain", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecEmailForward": { "post": { "description": "ExecEmailForward", "summary": "ExecEmailForward", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "disableForwarding", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ForwardExternal", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ForwardInternal", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "userID", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "KeepCopy", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecBECRemediate": { "post": { "description": "ExecBECRemediate", "summary": "ExecBECRemediate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "userid", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListPartnerRelationships": { "get": { "description": "ListPartnerRelationships", "summary": "ListPartnerRelationships", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAppsRepository": { "post": { "description": "ListAppsRepository", "summary": "ListAppsRepository", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Repository", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Search", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecClrImmId": { "get": { "description": "ExecClrImmId", "summary": "ExecClrImmId", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddGroupTemplate": { "post": { "description": "AddGroupTemplate", "summary": "AddGroupTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "membershipRule", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "allowExternal", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "groupType", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "username", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/Standards_IntuneTemplate": { "post": { "description": "Standards_IntuneTemplate", "summary": "Standards_IntuneTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RawJSON", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Assignto", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListIntuneTemplates": { "get": { "description": "ListIntuneTemplates", "summary": "ListIntuneTemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecResetPass": { "get": { "description": "ExecResetPass", "summary": "ExecResetPass", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "MustChange", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "displayName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAlertsList": { "get": { "description": "ExecAlertsList", "summary": "ExecAlertsList", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecQuarantineManagement": { "get": { "description": "ExecQuarantineManagement", "summary": "ExecQuarantineManagement", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AllowSender", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecRestoreDeleted": { "get": { "description": "ExecRestoreDeleted", "summary": "ExecRestoreDeleted", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserGroups": { "get": { "description": "ListUserGroups", "summary": "ListUserGroups", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveStandard": { "get": { "description": "RemoveStandard", "summary": "RemoveStandard", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserConditionalAccessPolicies": { "get": { "description": "ListUserConditionalAccessPolicies", "summary": "ListUserConditionalAccessPolicies", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListCAtemplates": { "get": { "description": "ListCAtemplates", "summary": "ListCAtemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListContacts": { "get": { "description": "ListContacts", "summary": "ListContacts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ContactID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListContactTemplates": { "get": { "description": "List Contact Templates", "summary": "List Contact Templates", "tags": [ "GET" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "description": "Successful operation" } } } }, "/RemoveContactTemplates": { "get": { "description": "Remove Contact Template", "summary": "Remove Contact Template", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddContactTemplates": { "post": { "description": "Add Contact Template", "summary": "Add Contact Template", "tags": [ "POST" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListContactPermissions": { "get": { "description": "ListContactPermissions - Retrieves contact folder permissions for a specified user", "summary": "ListContactPermissions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query", "description": "The user ID to retrieve contact permissions for" }, { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query", "description": "The tenant filter to specify which tenant" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Identity": { "type": "string", "description": "The identity of the contact folder" }, "User": { "type": "string", "description": "The user who has permissions" }, "AccessRights": { "type": "array", "items": { "type": "string" }, "description": "The access rights granted to the user" }, "FolderName": { "type": "string", "description": "The name of the contact folder" }, "MailboxInfo": { "type": "object", "description": "Information about the mailbox" } } } } } }, "description": "Successfully retrieved contact permissions" }, "403": { "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message" } } } } }, "description": "Forbidden - insufficient permissions" } } } }, "/ExecModifyContactPerms": { "post": { "description": "ExecModifyContactPerms - Modifies contact folder permissions for a specified user", "summary": "ExecModifyContactPerms", "tags": [ "POST" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userID", "tenantFilter", "permissions" ], "properties": { "userID": { "type": "string", "description": "The user ID whose contact permissions will be modified" }, "tenantFilter": { "type": "string", "description": "The tenant filter to specify which tenant" }, "permissions": { "type": "array", "description": "Array of permission objects to apply", "items": { "type": "object", "properties": { "PermissionLevel": { "type": "object", "properties": { "value": { "type": "string", "description": "Permission level (e.g., Owner, PublishingEditor, Editor, PublishingAuthor, Author, NonEditingAuthor, Reviewer, Contributor, AvailabilityOnly, LimitedDetails)" } } }, "Modification": { "type": "string", "description": "Type of modification (Add, Remove)", "enum": [ "Add", "Remove" ] }, "UserID": { "type": "array", "description": "Array of target users to grant/remove permissions", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "User ID or email address" } } } }, "CanViewPrivateItems": { "type": "boolean", "description": "Whether the user can view private items", "default": false }, "FolderName": { "type": "string", "description": "Name of the contact folder", "default": "Contact" }, "SendNotificationToUser": { "type": "boolean", "description": "Whether to send notification to the user", "default": false } }, "required": [ "PermissionLevel", "Modification", "UserID" ] } } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" }, "description": "Array of result messages for each permission operation" } } } } }, "description": "Successfully processed contact permission modifications" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" }, "description": "Error messages" } } } } }, "description": "Bad Request - Missing required parameters" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" }, "description": "Error messages" } } } } }, "description": "Not Found - User ID not found" }, "500": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" }, "description": "Error messages" } } } } }, "description": "Internal Server Error - Operation failed" } } } }, "/ListMailboxRules": { "get": { "description": "ListMailboxRules", "summary": "ListMailboxRules", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSites": { "get": { "description": "ListSites", "summary": "ListSites", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserUPN", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSetOoO": { "post": { "description": "ExecSetOoO", "summary": "ExecSetOoO", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "user", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "input", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Disable", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddExConnectorTemplate": { "post": { "description": "AddExConnectorTemplate", "summary": "AddExConnectorTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "name", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "cippconnectortype", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecOffboardUser": { "post": { "description": "ExecOffboardUser", "summary": "ExecOffboardUser", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "KeepCopy", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "OnedriveAccess", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "OOO", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AccessNoAutomap", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "forward", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "user", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTenantDetails": { "get": { "description": "ListTenantDetails", "summary": "ListTenantDetails", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecConverttoSharedMailbox": { "get": { "description": "ExecConverttoSharedMailbox", "summary": "ExecConverttoSharedMailbox", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ConvertToUser", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGraphRequest": { "get": { "description": "ExecGraphRequest", "summary": "ExecGraphRequest", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Endpoint", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DisablePagination", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDefenderState": { "get": { "description": "ListDefenderState", "summary": "ListDefenderState", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMailQuarantine": { "get": { "description": "ListMailQuarantine", "summary": "ListMailQuarantine", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListIntunePolicy": { "get": { "description": "ListIntunePolicy", "summary": "ListIntunePolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "URLName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecRevokeSessions": { "get": { "description": "ExecRevokeSessions", "summary": "ExecRevokeSessions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListmailboxPermissions": { "get": { "description": "ListmailboxPermissions", "summary": "ListmailboxPermissions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecExtensionsConfig": { "post": { "description": "ExecExtensionsConfig", "summary": "ExecExtensionsConfig", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "CIPPAPI", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDevices": { "get": { "description": "ListDevices", "summary": "ListDevices", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveCATemplate": { "get": { "description": "RemoveCATemplate", "summary": "RemoveCATemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveQueuedApp": { "get": { "description": "RemoveQueuedApp", "summary": "RemoveQueuedApp", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/DomainAnalyser_List": { "get": { "description": "DomainAnalyser_List", "summary": "DomainAnalyser_List", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddNamedLocation": { "post": { "description": "AddNamedLocation", "summary": "AddNamedLocation", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Ips", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "includeUnknownCountriesAndRegions", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Countries", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Trusted", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "policyName", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "selectedTenants", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTransportRulesTemplates": { "get": { "description": "ListTransportRulesTemplates", "summary": "ListTransportRulesTemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecEditCalendarPermissions": { "get": { "description": "ExecEditCalendarPermissions", "summary": "ExecEditCalendarPermissions", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "permissions", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserToGetPermissions", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "removeaccess", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "folderName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecDisableUser": { "get": { "description": "ExecDisableUser", "summary": "ExecDisableUser", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Enable", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddTransportRule": { "post": { "description": "AddTransportRule", "summary": "AddTransportRule", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "PowerShellCommand", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTenants": { "get": { "description": "ListTenants", "summary": "ListTenants", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ClearCache", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantsOnly", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AllTenantSelector", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecResetMFA": { "get": { "description": "ExecResetMFA", "summary": "ExecResetMFA", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListIntuneIntents": { "get": { "description": "ListIntuneIntents", "summary": "ListIntuneIntents", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListStandards": { "get": { "description": "ListStandards", "summary": "ListStandards", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDeletedItems": { "get": { "description": "ListDeletedItems", "summary": "ListDeletedItems", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGroupsHideFromGAL": { "get": { "description": "ExecGroupsHideFromGAL", "summary": "ExecGroupsHideFromGAL", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "groupType", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "HidefromGAL", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSendPush": { "get": { "description": "ExecSendPush", "summary": "ExecSendPush", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserEmail", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecExtensionMapping": { "post": { "description": "ExecExtensionMapping", "summary": "ExecExtensionMapping", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "mappings", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AddMapping", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecExtensionMapping", "summary": "ExecExtensionMapping", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "mappings", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AddMapping", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAppStatus": { "get": { "description": "ListAppStatus", "summary": "ListAppStatus", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AppFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/GetVersion": { "get": { "description": "GetVersion", "summary": "GetVersion", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "localversion", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecMailboxMobileDevices": { "get": { "description": "ExecMailboxMobileDevices", "summary": "ExecMailboxMobileDevices", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Userid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Quarantine", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Delete", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "deviceid", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveApp": { "get": { "description": "RemoveApp", "summary": "RemoveApp", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecPasswordConfig": { "post": { "description": "ExecPasswordConfig", "summary": "ExecPasswordConfig", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "List", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "passwordType", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecPasswordConfig", "summary": "ExecPasswordConfig", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "List", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "passwordType", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecHideFromGAL": { "get": { "description": "ExecHideFromGAL", "summary": "ExecHideFromGAL", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "HideFromGal", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditUser": { "post": { "description": "EditUser", "summary": "EditUser", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "CopyFrom", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListOAuthApps": { "get": { "description": "ListOAuthApps", "summary": "ListOAuthApps", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDeviceDetails": { "get": { "description": "ListDeviceDetails", "summary": "ListDeviceDetails", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DeviceSerial", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DeviceID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DeviceName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListLogs": { "get": { "description": "ListLogs", "summary": "ListLogs", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ListLogs", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Severity", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "User", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "DateFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Filter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAllTenantDeviceCompliance": { "get": { "description": "ListAllTenantDeviceCompliance", "summary": "ListAllTenantDeviceCompliance", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUsers": { "get": { "description": "ListUsers", "summary": "ListUsers", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "IncludeLogonDetails", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "graphFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMessageTrace": { "get": { "description": "ListMessageTrace", "summary": "ListMessageTrace", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Tracedetail", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "sender", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "days", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "recipient", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListPhishPolicies": { "get": { "description": "ListPhishPolicies", "summary": "ListPhishPolicies", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveSpamfilter": { "get": { "description": "RemoveSpamfilter", "summary": "RemoveSpamfilter", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "name", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecNotificationConfig": { "post": { "description": "ExecNotificationConfig", "summary": "ExecNotificationConfig", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Webhook", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Email", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "logsToInclude", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Severity", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "onePerTenant", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "sendtoIntegration", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSAMSetup": { "post": { "description": "ExecSAMSetup", "summary": "ExecSAMSetup", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "error_description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "setkeys", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "applicationsecret", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "error", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "CheckSetupProcess", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "count", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RefreshToken", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "applicationid", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "step", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "partnersetup", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "code", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "CreateSAM", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecSAMSetup", "summary": "ExecSAMSetup", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "error_description", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "setkeys", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "applicationsecret", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "error", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "CheckSetupProcess", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "count", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "RefreshToken", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "applicationid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "step", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "partnersetup", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "code", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "CreateSAM", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserMailboxDetails": { "get": { "description": "ListUserMailboxDetails", "summary": "ListUserMailboxDetails", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListExConnectorTemplates": { "get": { "description": "ListExConnectorTemplates", "summary": "ListExConnectorTemplates", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddDefenderDeployment": { "post": { "description": "AddDefenderDeployment", "summary": "AddDefenderDeployment", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ASR", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Compliance", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "EDR", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "selectedTenants", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Policy", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListGDAPInvite": { "get": { "description": "ListGDAPInvite", "summary": "ListGDAPInvite", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "RelationshipId", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddIntuneTemplate": { "post": { "description": "AddIntuneTemplate", "summary": "AddIntuneTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TemplateType", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "rawJSON", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "URLName", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "AddIntuneTemplate", "summary": "AddIntuneTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TemplateType", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "description", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "displayname", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "rawJSON", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "URLName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddAPDevice": { "post": { "description": "AddAPDevice", "summary": "AddAPDevice", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "autopilotData", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Groupname", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveTransportRuleTemplate": { "get": { "description": "RemoveTransportRuleTemplate", "summary": "RemoveTransportRuleTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMailboxMobileDevices": { "get": { "description": "ListMailboxMobileDevices", "summary": "ListMailboxMobileDevices", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Mailbox", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecExcludeTenant": { "post": { "description": "ExecExcludeTenant", "summary": "ExecExcludeTenant", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ListAll", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AddExclusion", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "value", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveExclusion", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecExcludeTenant", "summary": "ExecExcludeTenant", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ListAll", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AddExclusion", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "value", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "RemoveExclusion", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "List", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSetSecurityAlert": { "get": { "description": "ExecSetSecurityAlert", "summary": "ExecSetSecurityAlert", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "vendor", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "provider", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Status", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAddGDAPRole": { "post": { "description": "ExecAddGDAPRole", "summary": "ExecAddGDAPRole", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "gdapRoles", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "customSuffix", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListExchangeConnectors": { "get": { "description": "ListExchangeConnectors", "summary": "ListExchangeConnectors", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddTransportTemplate": { "post": { "description": "AddTransportTemplate", "summary": "AddTransportTemplate", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "PowerShellCommand", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "name", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecCreateTAP": { "get": { "description": "ExecCreateTAP", "summary": "ExecCreateTAP", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveCAPolicy": { "get": { "description": "RemoveCAPolicy", "summary": "RemoveCAPolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "GUID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveTransportRule": { "get": { "description": "RemoveTransportRule", "summary": "RemoveTransportRule", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveAPDevice": { "get": { "description": "RemoveAPDevice", "summary": "RemoveAPDevice", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddPolicy": { "post": { "description": "AddPolicy", "summary": "AddPolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TemplateType", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "replacemap", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "RawJSON", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Assignto", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddContact": { "post": { "description": "AddContact", "summary": "AddContact", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/PublicScripts": { "get": { "description": "PublicScripts", "summary": "PublicScripts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Guid", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveContact": { "get": { "description": "RemoveContact", "summary": "RemoveContact", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditTransportRule": { "get": { "description": "EditTransportRule", "summary": "EditTransportRule", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "state", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddSpamFilter": { "post": { "description": "AddSpamFilter", "summary": "AddSpamFilter", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "PowerShellCommand", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveIntuneTemplate": { "get": { "description": "RemoveIntuneTemplate", "summary": "RemoveIntuneTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGroupsDeliveryManagement": { "get": { "description": "ExecGroupsDeliveryManagement", "summary": "ExecGroupsDeliveryManagement", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "GroupType", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "OnlyAllowInternal", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListUserDevices": { "get": { "description": "ListUserDevices", "summary": "ListUserDevices", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditTenant": { "post": { "description": "EditTenant", "summary": "EditTenant", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "displayName", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "defaultDomainName", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "customerId", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAppApproval": { "get": { "description": "ExecAppApproval", "summary": "ExecAppApproval", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "applicationid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListInactiveAccounts": { "get": { "description": "ListInactiveAccounts", "summary": "ListInactiveAccounts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddAlert": { "post": { "description": "AddAlert", "summary": "AddAlert", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "ApnCertExpiry", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "NewRole", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "MFAAlertUsers", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "DefenderMalware", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "NewGA", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "QuotaUsed", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AppSecretExpiry", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "OverusedLicenses", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "VppTokenExpiry", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "SecDefaultsUpsell", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "NoCAConfig", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "DefenderStatus", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "AdminPassword", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "MFAAdmins", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "DepTokenExpiry", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "SharePointQuota", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ExpiringLicenses", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "UnusedLicenses", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMailboxes": { "get": { "description": "ListMailboxes", "summary": "ListMailboxes", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMFAUsers": { "get": { "description": "ListMFAUsers", "summary": "ListMFAUsers", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveGroupTemplate": { "get": { "description": "RemoveGroupTemplate", "summary": "RemoveGroupTemplate", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecRunBackup": { "get": { "description": "ExecRunBackup", "summary": "ExecRunBackup", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Selected", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListTransportRules": { "get": { "description": "ListTransportRules", "summary": "ListTransportRules", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecMaintenanceScripts": { "get": { "description": "ExecMaintenanceScripts", "summary": "ExecMaintenanceScripts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "MakeLink", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ScriptFile", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/GetCippAlerts": { "get": { "description": "GetCippAlerts", "summary": "GetCippAlerts", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "localversion", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecGDAPMigration": { "post": { "description": "ExecGDAPMigration", "summary": "ExecGDAPMigration", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "selectedTenants", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "gdapRoles", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListGroups": { "get": { "description": "ListGroups", "summary": "ListGroups", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "GroupID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "owners", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "members", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListDomains": { "get": { "description": "ListDomains", "summary": "ListDomains", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListExternalTenantInfo": { "get": { "description": "ListExternalTenantInfo", "summary": "ListExternalTenantInfo", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenant", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListAPDevices": { "get": { "description": "ListAPDevices", "summary": "ListAPDevices", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "UserID", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddAutopilotConfig": { "post": { "description": "AddAutopilotConfig", "summary": "AddAutopilotConfig", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Displayname", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Description", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Assignto", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddCAPolicy": { "post": { "description": "AddCAPolicy", "summary": "AddCAPolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "RawJSON", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMailboxStatistics": { "get": { "description": "ListMailboxStatistics", "summary": "ListMailboxStatistics", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAssignApp": { "get": { "description": "ExecAssignApp", "summary": "ExecAssignApp", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "ID", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "AssignTo", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecExtensionTest": { "get": { "description": "ExecExtensionTest", "summary": "ExecExtensionTest", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "extensionName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecSetMailboxQuota": { "post": { "description": "ExecSetMailboxQuota", "summary": "ExecSetMailboxQuota", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "input", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ProhibitSendReceiveQuota", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ProhibitSendQuota", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "IssueWarningQuota", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "user", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListNamedLocations": { "get": { "description": "ListNamedLocations", "summary": "ListNamedLocations", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListMFAUsersAllTenants": { "get": { "description": "ListMFAUsersAllTenants", "summary": "ListMFAUsersAllTenants", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveQueuedAlert": { "get": { "description": "RemoveQueuedAlert", "summary": "RemoveQueuedAlert", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecAccessChecks": { "post": { "description": "ExecAccessChecks", "summary": "ExecAccessChecks", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Tenants", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "Permissions", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } }, "get": { "description": "ExecAccessChecks", "summary": "ExecAccessChecks", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "Tenants", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "tenantid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Permissions", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSharedMailboxAccountEnabled": { "get": { "description": "ListSharedMailboxAccountEnabled", "summary": "ListSharedMailboxAccountEnabled", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "TenantFilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListSpamfilter": { "get": { "description": "ListSpamfilter", "summary": "ListSpamfilter", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ListQuarantinePolicy": { "get": { "description": "ListQuarantinePolicy", "summary": "ListQuarantinePolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddQuarantinePolicy": { "post": { "description": "AddQuarantinePolicy", "summary": "AddQuarantinePolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Name", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "BlockSender", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "Delete", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "Preview", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ReleaseActionPreference", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "AllowSender", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "QuarantineNotification", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "IncludeMessagesFromBlockedSenderAddress", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditQuarantinePolicy": { "post": { "description": "EditQuarantinePolicy", "summary": "EditQuarantinePolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Identity", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "EndUserSpamNotificationFrequency", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "EndUserSpamNotificationCustomFromAddress", "in": "body" }, { "required": false, "schema": { "type": "boolean" }, "name": "OrganizationBrandingEnabled", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "BlockSender", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "Delete", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "Preview", "in": "body" }, { "required": true, "schema": { "type": "string" }, "name": "ReleaseActionPreference", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "AllowSender", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "QuarantineNotification", "in": "body" }, { "required": true, "schema": { "type": "boolean" }, "name": "IncludeMessagesFromBlockedSenderAddress", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveExConnector": { "get": { "description": "RemoveExConnector", "summary": "RemoveExConnector", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "guid", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Type", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/RemoveQuarantinePolicy": { "get": { "description": "RemoveQuarantinePolicy", "summary": "RemoveQuarantinePolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantfilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Identity", "in": "body" }, { "required": false, "schema": { "type": "string" }, "name": "Name", "in": "body" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } } }, "/ExecDeleteSafeLinksPolicy": { "get": { "description": "ExecDeleteSafeLinksPolicy", "summary": "ExecDeleteSafeLinksPolicy", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "RuleName", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "PolicyName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/EditSafeLinksPolicy": { "post": { "description": "EditSafeLinksPolicy", "summary": "EditSafeLinksPolicy", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "PolicyName", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Name": { "type": "string" }, "EnableSafeLinksForEmail": { "type": "boolean" }, "EnableSafeLinksForTeams": { "type": "boolean" }, "EnableSafeLinksForOffice": { "type": "boolean" }, "TrackClicks": { "type": "boolean" }, "AllowClickThrough": { "type": "boolean" }, "ScanUrls": { "type": "boolean" }, "EnableForInternalSenders": { "type": "boolean" }, "DeliverMessageAfterScan": { "type": "boolean" }, "DisableUrlRewrite": { "type": "boolean" }, "DoNotRewriteUrls": { "type": "array", "items": { "type": "string" } }, "AdminDisplayName": { "type": "string" }, "CustomNotificationText": { "type": "string" }, "EnableOrganizationBranding": { "type": "boolean" }, "Priority": { "type": "integer" }, "Comments": { "type": "string" }, "Enabled": { "type": "boolean" }, "SentTo": { "type": "array", "items": { "type": "string" } }, "ExceptIfSentTo": { "type": "array", "items": { "type": "string" } }, "SentToMemberOf": { "type": "array", "items": { "type": "string" } }, "ExceptIfSentToMemberOf": { "type": "array", "items": { "type": "string" } }, "RecipientDomainIs": { "type": "array", "items": { "type": "string" } }, "ExceptIfRecipientDomainIs": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" } } } } } }, "description": "Successful operation" } } } }, "/ListSafeLinksPolicyDetails": { "get": { "description": "ListSafeLinksPolicyDetails", "summary": "ListSafeLinksPolicyDetails", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "PolicyName", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "RuleName", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "object", "properties": { "Policy": { "type": "object", "properties": { "Name": { "type": "string" }, "EnableSafeLinksForEmail": { "type": "boolean" }, "EnableSafeLinksForTeams": { "type": "boolean" }, "EnableSafeLinksForOffice": { "type": "boolean" }, "TrackClicks": { "type": "boolean" }, "AllowClickThrough": { "type": "boolean" }, "ScanUrls": { "type": "boolean" }, "EnableForInternalSenders": { "type": "boolean" }, "DeliverMessageAfterScan": { "type": "boolean" }, "DisableUrlRewrite": { "type": "boolean" }, "DoNotRewriteUrls": { "type": "array", "items": { "type": "string" } }, "AdminDisplayName": { "type": "string" }, "CustomNotificationText": { "type": "string" }, "EnableOrganizationBranding": { "type": "boolean" } } }, "Rule": { "type": "object", "properties": { "Name": { "type": "string" }, "Priority": { "type": "integer" }, "Comments": { "type": "string" }, "State": { "type": "string" }, "SentTo": { "type": "array", "items": { "type": "string" } }, "ExceptIfSentTo": { "type": "array", "items": { "type": "string" } }, "SentToMemberOf": { "type": "array", "items": { "type": "string" } }, "ExceptIfSentToMemberOf": { "type": "array", "items": { "type": "string" } }, "RecipientDomainIs": { "type": "array", "items": { "type": "string" } }, "ExceptIfRecipientDomainIs": { "type": "array", "items": { "type": "string" } } } }, "Message": { "type": "string" } } } } } } }, "description": "Successful operation" } } } }, "/ExecNewSafeLinksPolicy": { "post": { "description": "Create a new SafeLinks policy and associated rule", "summary": "Create SafeLinks Policy and Rule Configuration", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": true, "schema": { "type": "string" }, "name": "Name", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "EnableSafeLinksForEmail": { "type": "boolean", "description": "Enable Safe Links protection for email messages" }, "EnableSafeLinksForTeams": { "type": "boolean", "description": "Enable Safe Links protection for Teams messages" }, "EnableSafeLinksForOffice": { "type": "boolean", "description": "Enable Safe Links protection for Office applications" }, "TrackClicks": { "type": "boolean", "description": "Track user clicks related to Safe Links protection" }, "AllowClickThrough": { "type": "boolean", "description": "Allow users to click through to the original URL" }, "ScanUrls": { "type": "boolean", "description": "Enable real-time scanning of URLs" }, "EnableForInternalSenders": { "type": "boolean", "description": "Enable Safe Links for messages sent between internal senders" }, "DeliverMessageAfterScan": { "type": "boolean", "description": "Wait until URL scanning is complete before delivering the message" }, "DisableUrlRewrite": { "type": "boolean", "description": "Disable the rewriting of URLs in messages" }, "DoNotRewriteUrls": { "type": "array", "items": { "type": "string" }, "description": "List of URLs that will not be rewritten by Safe Links" }, "AdminDisplayName": { "type": "string", "description": "Display name for the policy in the admin interface" }, "CustomNotificationText": { "type": "string", "description": "Custom text for the notification when a link is blocked" }, "EnableOrganizationBranding": { "type": "boolean", "description": "Enable organization branding on warning pages" }, "Priority": { "type": "integer", "description": "Priority of the rule (lower numbers = higher priority)" }, "Comments": { "type": "string", "description": "Administrative comments for the rule" }, "Enabled": { "type": "boolean", "description": "Whether the rule is enabled or disabled" }, "SentTo": { "type": "array", "items": { "type": "string" }, "description": "Apply the rule if the recipient is any of these email addresses" }, "SentToMemberOf": { "type": "array", "items": { "type": "string" }, "description": "Apply the rule if the recipient is a member of any of these groups" }, "RecipientDomainIs": { "type": "array", "items": { "type": "string" }, "description": "Apply the rule if the recipient's domain matches any of these domains" }, "ExceptIfSentTo": { "type": "array", "items": { "type": "string" }, "description": "Do not apply the rule if the recipient is any of these email addresses" }, "ExceptIfSentToMemberOf": { "type": "array", "items": { "type": "string" }, "description": "Do not apply the rule if the recipient is a member of any of these groups" }, "ExceptIfRecipientDomainIs": { "type": "array", "items": { "type": "string" }, "description": "Do not apply the rule if the recipient's domain matches any of these domains" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Result message from the operation" } } } } }, "description": "Successfully created SafeLinks policy and rule" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } } } } }, "/ListSafeLinksPolicyTemplates": { "get": { "description": "List SafeLinks Policy Templates", "summary": "List SafeLinks Policy Templates", "tags": [ "GET" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": {} } } } }, "description": "Successful operation" } } } }, "/RemoveSafeLinksPolicyTemplate": { "get": { "description": "Remove SafeLinks Policy Template", "summary": "Remove SafeLinks Policy Template", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "id", "in": "query" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddSafeLinksPolicyTemplate": { "post": { "description": "Add SafeLinks Policy Template", "summary": "Add SafeLinks Policy Template", "tags": [ "POST" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/AddSafeLinksPolicyFromTemplate": { "post": { "description": "Deploy SafeLinks Policy From Template", "summary": "Deploy SafeLinks Policy From Template", "tags": [ "POST" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": {}, "type": "object" } } }, "description": "Successful operation" } } } }, "/ExecManageRetentionPolicies": { "get": { "description": "List retention policies or get a specific retention policy by name", "summary": "Get Retention Policies", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "name", "in": "query", "description": "Name of specific retention policy to retrieve" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string" }, "RetentionPolicyTagLinks": { "type": "array", "items": { "type": "string" } } } } } } }, "description": "Successfully retrieved retention policies" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } } } }, "post": { "description": "Create, modify, or delete retention policies", "summary": "Manage Retention Policies", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CreatePolicies": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the retention policy" }, "RetentionPolicyTagLinks": { "type": "array", "items": { "type": "string" }, "description": "Array of retention tag names to link to this policy" } }, "required": [ "Name" ] }, "description": "Array of retention policies to create" }, "ModifyPolicies": { "type": "array", "items": { "type": "object", "properties": { "Identity": { "type": "string", "description": "Identity of the retention policy to modify" }, "Name": { "type": "string", "description": "New name for the retention policy" }, "RetentionPolicyTagLinks": { "type": "array", "items": { "type": "string" }, "description": "Array of retention tag names to link to this policy" }, "AddTags": { "type": "array", "items": { "type": "string" }, "description": "Array of retention tag names to add to the policy" }, "RemoveTags": { "type": "array", "items": { "type": "string" }, "description": "Array of retention tag names to remove from the policy" } }, "required": [ "Identity" ] }, "description": "Array of retention policies to modify" }, "DeletePolicies": { "type": "array", "items": { "type": "string" }, "description": "Array of retention policy identities to delete" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "description": "Successfully processed retention policy operations" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/ExecManageRetentionTags": { "get": { "description": "List retention tags or get a specific retention tag by name", "summary": "Get Retention Tags", "tags": [ "GET" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" }, { "required": false, "schema": { "type": "string" }, "name": "name", "in": "query", "description": "Name of specific retention tag to retrieve" } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string" }, "Type": { "type": "string" }, "RetentionAction": { "type": "string" }, "AgeLimitForRetention": { "type": "integer" }, "RetentionEnabled": { "type": "boolean" } } } } } }, "description": "Successfully retrieved retention tags" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "string", "description": "Error message" } } } } } } } }, "post": { "description": "Create, modify, or delete retention tags", "summary": "Manage Retention Tags", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CreateTags": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "Name of the retention tag (max 64 characters)" }, "Type": { "type": "string", "enum": [ "All", "Inbox", "SentItems", "DeletedItems", "Drafts", "Outbox", "JunkEmail", "Journal", "SyncIssues", "ConversationHistory", "Personal", "RecoverableItems", "NonIpmRoot", "LegacyArchiveJournals", "Clutter", "Calendar", "Notes", "Tasks", "Contacts", "RssSubscriptions", "ManagedCustomFolder" ], "description": "Type of the retention tag" }, "RetentionAction": { "type": "string", "enum": [ "DeleteAndAllowRecovery", "PermanentlyDelete", "MoveToArchive", "MarkAsPastRetentionLimit" ], "description": "Action to take when retention period expires" }, "AgeLimitForRetention": { "type": "integer", "minimum": 0, "maximum": 24855, "description": "Age limit for retention in days" }, "RetentionEnabled": { "type": "boolean", "description": "Whether retention is enabled for this tag" }, "Comment": { "type": "string", "description": "Administrative comment for the tag" }, "LocalizedComment": { "type": "string", "description": "Localized comment for the tag" }, "LocalizedRetentionPolicyTagName": { "type": "string", "description": "Localized name for the retention policy tag" } }, "required": [ "Name", "Type" ] }, "description": "Array of retention tags to create" }, "ModifyTags": { "type": "array", "items": { "type": "object", "properties": { "Identity": { "type": "string", "description": "Identity of the retention tag to modify" }, "Name": { "type": "string", "description": "New name for the retention tag" }, "RetentionAction": { "type": "string", "enum": [ "DeleteAndAllowRecovery", "PermanentlyDelete", "MoveToArchive", "MarkAsPastRetentionLimit" ], "description": "Action to take when retention period expires" }, "AgeLimitForRetention": { "type": "integer", "minimum": 0, "maximum": 24855, "description": "Age limit for retention in days" }, "RetentionEnabled": { "type": "boolean", "description": "Whether retention is enabled for this tag" }, "Comment": { "type": "string", "description": "Administrative comment for the tag" }, "LocalizedComment": { "type": "string", "description": "Localized comment for the tag" }, "LocalizedRetentionPolicyTagName": { "type": "string", "description": "Localized name for the retention policy tag" } }, "required": [ "Identity" ] }, "description": "Array of retention tags to modify" }, "DeleteTags": { "type": "array", "items": { "type": "string" }, "description": "Array of retention tag identities to delete" } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "description": "Successfully processed retention tag operations" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/ExecSetMailboxRetentionPolicies": { "post": { "description": "Apply a retention policy to one or more mailboxes", "summary": "Set Mailbox Retention Policies", "tags": [ "POST" ], "parameters": [ { "required": true, "schema": { "type": "string" }, "name": "tenantFilter", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "PolicyName": { "type": "string", "description": "Name of the retention policy to apply" }, "Mailboxes": { "type": "array", "items": { "type": "string" }, "description": "Array of mailbox identities (email addresses or names) to apply the policy to" } }, "required": [ "PolicyName", "Mailboxes" ] } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" }, "description": "Array of result messages for each mailbox operation" } } } } }, "description": "Successfully processed mailbox retention policy assignments" }, "400": { "description": "Bad request - missing required parameters", "content": { "application/json": { "schema": { "type": "string" } } } }, "403": { "description": "Forbidden - insufficient permissions", "content": { "application/json": { "schema": { "type": "object", "properties": { "Results": { "type": "array", "items": { "type": "string" } } } } } } } } } }, "openapi": "3.1.0", "servers": [ { "variables": { "url": { "description": "The base URL for the API. Enter your server URL here.", "default": "CIPPURL.com" } }, "url": "https://{url}/api/", "description": "CIPP-API" } ], "tags": [ { "name": "GET", "description": "GET methods" }, { "name": "POST", "description": "POST methods" } ] }