Edit

Share via


Update qrCodePinAuthenticationMethodConfiguration

Namespace: microsoft.graph

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.

Update the properties of a qrCodePinAuthenticationMethodConfiguration object.

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) Policy.ReadWrite.AuthenticationMethod Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.ReadWrite.AuthenticationMethod Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Authentication Policy Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /policies/authenticationmethodspolicy/authenticationmethodconfigurations/qrcodepin

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.

Property Type Description
state authenticationMethodState Whether the policy is enabled or disabled. Inherited from microsoft.authMethodPolicy.authenticationMethodConfiguration. The possible values are: enabled, disabled.
excludeTargets microsoft.graph.excludeTarget collection Users or groups excluded from using the QR code authentication method by policy. Inherited from microsoft.authMethodPolicy.authenticationMethodConfiguration.
standardQRCodeLifetimeInDays Int32 Configured lifetime of standard QR code for all enabled users. Default is 365 days and maximum allowed lifetime is 395 days.
pinLength Int32 Default and minimum length is 8 digit. Max. allowed is up to 20 digits.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

PATCH https://graph.microsoft.com/beta/policies/authenticationmethodspolicy/authenticationmethodconfigurations/qrcodepin
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.qrCodePinAuthenticationMethodConfiguration",
  "state": "enabled",
  "standardQRCodeLifetimeInDays": 365,
  "pinLength": 8
}

Response

The following example shows the response.

HTTP/1.1 204 No Content