Edit

Share via

Get 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.

Retrieve the contents of an existing trustFrameworkPolicy.

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

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

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

Optional query parameters

This method supports the $select and $expand OData query parameters to help customize the response.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and an XML representation of the trustFrameworkPolicy in the response body.

Note: the response content type will be application/xml.

Example

The following example retrieves a specific trustFrameworkPolicy.

Request
GET https://graph.microsoft.com/beta/trustFramework/policies/B2C_1A_Test/$value
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>