Update temporaryAccessPassAuthenticationMethodConfiguration

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 temporaryAccessPassAuthenticationMethodConfiguration object, which represents the Temporary Access Pass authentication method policy for the Azure AD tenant.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Policy.ReadWrite.AuthenticationMethod
Delegated (personal Microsoft account) Not supported.
Application Policy.ReadWrite.AuthenticationMethod

For delegated scenarios, the administrator needs the Global admin role. For more information, seeroles.

HTTP request

PATCH /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/TemporaryAccessPass

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the temporaryAccessPassAuthenticationMethodConfiguration object with the values of fields that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values. For best performance, don't include existing values that haven't changed.

All properties of the object can be updated. For a list of properties, see temporaryAccessPassAuthenticationMethodConfiguration.

Note: The @odata.type property with a value of #microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration must be included in the body.

Response

If successful, this method returns a 204 No Content response code. It does not return anything in the response body.

Examples

Request

PATCH https://graph.microsoft.com/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/TemporaryAccessPass
Content-Type: application/json

{
  "@odata.type":"#microsoft.graph.temporaryAccessPassAuthenticationMethodConfiguration",
  "state":"enabled",
  "defaultLifetimeInMinutes":60,
  "defaultLength":8,
  "minimumLifetimeInMinutes":60,
  "maximumLifetimeInMinutes":1440,"
  isUsableOnce":false,
  "includeTargets": [
        {
            "targetType": "group",
            "id": "all_users",
            "isRegistrationRequired": false,
            "useForSignIn": true
        }
    ]
}


Response

HTTP/1.1 204 No Content