Create urlThreatSubmission

Article
2024-04-04

Namespace: microsoft.graph.security

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new urlThreatSubmission object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	ThreatSubmission.ReadWrite	ThreatSubmission.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	ThreatSubmission.ReadWrite.All	Not available.

HTTP request

POST /security/threatSubmission/urlThreats

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the urlThreatSubmission object.

You may also specify the following properties when creating an urlThreatSubmission.

Property	Type	Description
category	submissionCategory	Inherited from threatSubmission and required field. The possible values are: `notJunk`, `spam`, `phishing`, `malware`, `unknownFutureValue`. It is use to tell what you are reporting the URL as.
webUrl	String	The webUrl to be submitted. Required.

Response

If successful, this method returns a 201 Created response code and an urlThreatSubmission object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/security/threatSubmission/urlThreats
Content-type: application/json

{
  "@odata.type": "#microsoft.graph.urlThreatSubmission",
  "category": "phishing",
  "webUrl": "http://phishing.contoso.com"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models.Security;

var requestBody = new UrlThreatSubmission
{
	OdataType = "#microsoft.graph.urlThreatSubmission",
	Category = SubmissionCategory.Phishing,
	WebUrl = "http://phishing.contoso.com",
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Security.ThreatSubmission.UrlThreats.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta security threat-submission url-threats create --body '{\
  "@odata.type": "#microsoft.graph.urlThreatSubmission",\
  "category": "phishing",\
  "webUrl": "http://phishing.contoso.com"\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodelssecurity "github.com/microsoftgraph/msgraph-beta-sdk-go/models/security"
	  //other-imports
)

requestBody := graphmodelssecurity.NewUrlThreatSubmission()
category := graphmodels.PHISHING_SUBMISSIONCATEGORY 
requestBody.SetCategory(&category) 
webUrl := "http://phishing.contoso.com"
requestBody.SetWebUrl(&webUrl) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
urlThreats, err := graphClient.Security().ThreatSubmission().UrlThreats().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.models.security.UrlThreatSubmission urlThreatSubmission = new com.microsoft.graph.beta.models.security.UrlThreatSubmission();
urlThreatSubmission.setOdataType("#microsoft.graph.urlThreatSubmission");
urlThreatSubmission.setCategory(com.microsoft.graph.beta.models.security.SubmissionCategory.Phishing);
urlThreatSubmission.setWebUrl("http://phishing.contoso.com");
com.microsoft.graph.models.security.UrlThreatSubmission result = graphClient.security().threatSubmission().urlThreats().post(urlThreatSubmission);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const urlThreatSubmission = {
  '@odata.type': '#microsoft.graph.urlThreatSubmission',
  category: 'phishing',
  webUrl: 'http://phishing.contoso.com'
};

await client.api('/security/threatSubmission/urlThreats')
	.version('beta')
	.post(urlThreatSubmission);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Security\UrlThreatSubmission;
use Microsoft\Graph\Beta\Generated\Models\Security\SubmissionCategory;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new UrlThreatSubmission();
$requestBody->setOdataType('#microsoft.graph.urlThreatSubmission');
$requestBody->setCategory(new SubmissionCategory('phishing'));
$requestBody->setWebUrl('http://phishing.contoso.com');

$result = $graphServiceClient->security()->threatSubmission()->urlThreats()->post($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Beta.Security

$params = @{
	"@odata.type" = "#microsoft.graph.urlThreatSubmission"
	category = "phishing"
	webUrl = "http://phishing.contoso.com"
}

New-MgBetaSecurityThreatSubmissionUrlThreat -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.security.url_threat_submission import UrlThreatSubmission
from msgraph_beta.generated.models.submission_category import SubmissionCategory
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = UrlThreatSubmission(
	odata_type = "#microsoft.graph.urlThreatSubmission",
	category = SubmissionCategory.Phishing,
	web_url = "http://phishing.contoso.com",
)

result = await graph_client.security.threat_submission.url_threats.post(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#security/threatSubmission/urlThreatSubmission/$entity",
  "@odata.type": "#microsoft.graph.security.urlThreatSubmission",
  "category": "phishing",
  "id": "49c5ef5b-1f65-444a-e6b9-08d772ea2059",
  "createdDateTime": "2021-10-10T03:30:18.6890937Z",
  "contentType": "url",
  "webUrl": "http://phishing.contoso.com",
  "status": "running",
  "source": "administrator",
  "createdBy": {
    "user": {
      "identity": "c52ce8db-3e4b-4181-93c4-7d6b6bffaf60",
      "displayName": "Ronald Admin",
      "email": "[email protected]"
    }
  },
  "result": {
  	"detail": "underInvestigation"
  },
  "adminReview": null,
  "tenantId" : "39238e87-b5ab-4ef6-a559-af54c6b07b42"
}

Share via

Create urlThreatSubmission

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources