Edit

Share via

Update or create trustFrameworkPolicy

  • Article

Namespace: microsoft.graph

Important: APIs under the /beta version in Microsoft Graph are in preview and are subject to change. Use of these APIs in production applications is not supported.

Update an existing trustFrameworkPolicy or create one if it does not exist.

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) Policy.ReadWrite.TrustFramework Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.ReadWrite.TrustFramework 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. B2C IEF Policy Administrator is the least privileged role supported for this operation.

HTTP request

PUT /trustFramework/policies/{id}/$value

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/xml. Required.

Request body

In the request body, provide an XML representation of the trustFrameworkPolicy object.

Note: the content type must be application/xml.

Response

The response will be one of the following:

  • If a trustFrameworkPolicy exists, a successful request returns a 200 OK response code.
  • If a trustFrameworkPolicy does not exist, a successful request returns a 201 Created response code.
  • If unsuccessful, a 4xx error will be returned with specific details.

Example

The following example updates a trustFrameworkPolicy.

Request
PUT https://graph.microsoft.com/beta/trustFramework/policies/B2C_1A_SocialAndLocalAccounts_Base/$value
Content-Type: application/xml

<TrustFrameworkPolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/online/cpim/schemas/2013/06" PolicySchemaVersion="0.3.0.0" TenantId="contoso.com" PolicyId="B2C_1A_SocialAndLocalAccounts_Base">
    <!---PolicyContent-->
</TrustFrameworkPolicy>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<TrustFrameworkPolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/online/cpim/schemas/2013/06" PolicySchemaVersion="0.3.0.0" TenantId="contoso.com" PolicyId="B2C_1A_Test" PublicPolicyUri="http://contoso.com/B2C_1A_Test">
    .....
    ....
    <!---PolicyContent-->
    ....
    ....
</TrustFrameworkPolicy>