Update federatedTokenValidationPolicy

Namespace: microsoft.graph

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.

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

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that aren't included in the request body maintains their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

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.

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"]
  }
}

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);

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"
  }
}