Edit

Share via


Update webApplicationFirewallProvider

Namespace: microsoft.graph

Update the properties of a webApplicationFirewallProvider 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) RiskPreventionProviders.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application RiskPreventionProviders.ReadWrite.All Not available.

Important

In delegated scenarios with work or school accounts, the admin must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. The following least privileged roles are supported for this operation:

  • External ID User Flow Administrator
  • Application Administrator
  • Security Administrator

HTTP request

PATCH /identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProviderId}

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 only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

You must specify the @odata.type property to specify the type of webApplicationFirewallProvider object to update. For example, "@odata.type": "#microsoft.graph.akamaiWebApplicationFirewallProvider".

Property Type Description
displayName String The friendly display name of the Web Application Firewall provider configuration.
accessToken String Akamai API access token used to authenticate to the Akamai account. Contact your Akamai Customer Success Manager for assistance with your accessToken. Supported for Akamai only.
clientSecret String Akamai API client secret used in conjunction with the client token and access token for authentication. Contact your Akamai Customer Success Manager for assistance with this information. Supported for Akamai only.
clientToken String Akamai API client token used for authentication to the Akamai account. Contact your Akamai Customer Success Manager for assistance with this information. Supported for Akamai only.
hostPrefix String Prefix used to identify the host or domain in Akamai configuration operations. This value may be required for certain API calls or configuration scenarios. Supported for Akamai only.
apiToken String Cloudflare API token or credential used by Microsoft services to authenticate to the Cloudflare account. Contact your Cloudflare Customer Success Manager for assistance with your apitoken. Supported for Cloudflare only.
zoneId String Default Cloudflare Zone ID associated with this provider configuration. This ID identifies the DNS zone in Cloudflare that is commonly used for verification and configuration operations for the provider. Supported for Cloudflare only.

Response

If successful, this method returns a 200 OK response code and an updated webApplicationFirewallProvider object in the response body.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/v1.0/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProviderId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudFlareWebApplicationFirewallProvider",
  "displayName": "String"
}

Response

The following example shows the response.

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.cloudFlareWebApplicationFirewallProvider",
  "id": "4d8ac75a-e882-18c6-8ad4-2ab20c742e52",
  "displayName": "String"
}