Update federatedTokenValidationPolicy

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 federatedTokenValidationPolicy 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 permission	Higher privileged permissions
Delegated (work or school account)	Not supported.	Not supported.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

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. Global Administrator is the only privileged role supported for this operation.

HTTP request

PUT /policies/federatedTokenValidationPolicy

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
validatingDomains	validatingDomains	Verified domains that Microsoft Entra validates whether the federated account's root domain matches with the mapped Microsoft Entra account's root domain. Required.

Response

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

Examples

Request

The following example shows a request.

HTTP

PUT https://graph.microsoft.com/beta/policies/federatedTokenValidationPolicy
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.federatedTokenValidationPolicy",
  "deletedDateTime": "String (timestamp)",
  "validatingDomains": {
    "@odata.type": "microsoft.graph.validatingDomains",
    "rootDomains": "enumerated",
    "domainNames": ["contoso.com","fabrikam.com"]
  }
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const federatedTokenValidationPolicy = {
  '@odata.type': '#microsoft.graph.federatedTokenValidationPolicy',
  deletedDateTime: 'String (timestamp)',
  validatingDomains: {
    '@odata.type': 'microsoft.graph.validatingDomains',
    rootDomains: 'enumerated',
    domainNames: ['contoso.com','fabrikam.com']
  }
};

await client.api('/policies/federatedTokenValidationPolicy')
	.version('beta')
	.put(federatedTokenValidationPolicy);

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.

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.federatedTokenValidationPolicy",
  "id": "932b8f7f-68c1-6fe5-59ab-56e1ff752f30",
  "deletedDateTime": "2023-08-25T07:44:46.2616778Z",
  "validatingDomains": {
    "@odata.type": "microsoft.graph.validatingDomains"
  }
}