Agreement.Read.All | Graph Permissions

Permission Details

Application Permission

Read all terms of use agreements

Allows the app to read terms of use agreements, without a signed in user.

Permission ID: 2f3e6f8c-093b-4c57-a58b-ba5ce494a169

Delegated Permission

Read all terms of use agreements

Allows the app to read terms of use agreements on behalf of the signed-in user.

Permission ID: af2819c9-df71-4dd3-ade7-4d7c9dc653b7

Properties

Microsoft Graph v1.0 exact-category-docs

Properties is shown from stable Microsoft Graph v1.0 metadata.

Property	Type	Description
`displayName`	`String`Nullable	Display name of the agreement. The display name is used for internal tracking of the agreement but isn't shown to end users who view the agreement. Supports $filter (eq).
`id`	`String`	The identifier of the agreement. Read-only. Supports $filter (eq).
`isPerDeviceAcceptanceRequired`	`Boolean`Nullable	Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Microsoft Entra ID, if they haven't already done so. Supports $filter (eq).
`isViewingBeforeAcceptanceRequired`	`Boolean`Nullable	Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).
`termsExpiration`	`termsExpiration`	Expiration schedule and frequency of agreement for all users. Supports $filter (eq).
`userReacceptRequiredFrequency`	`Duration`Nullable	The duration after which the user must reaccept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq).
`acceptances`	`agreementAcceptance collection`	Read-only. Information about acceptances of this agreement.
`file`	`object`	Default PDF linked to this agreement.
`files`	`agreementFileLocalization collection`	PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.

JSON Representation

Microsoft Graph v1.0 exact-category-docs

JSON representation is shown from stable Microsoft Graph v1.0 metadata.

JSON representation

{
  "@odata.type": "#microsoft.graph.agreement",
  "displayName": "String",
  "id": "String (identifier)",
  "isPerDeviceAcceptanceRequired": "Boolean",
  "isViewingBeforeAcceptanceRequired": "Boolean",
  "termsExpiration": {
    "@odata.type": "microsoft.graph.termsExpiration"
  },
  "userReacceptRequiredFrequency": "String (duration)"
}

Relationships

Microsoft Graph v1.0 exact-category-docs

Relationships is shown from stable Microsoft Graph v1.0 metadata.

Relationship	Type	Description
`acceptances`	`agreementAcceptance collection`	Read-only. Information about acceptances of this agreement.
`file`	`agreementFile`	Default PDF linked to this agreement.
`files`	`agreementFileLocalization collection`	PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.

Graph Methods

Delegated access App-only access

Exact Microsoft Learn match

Microsoft Graph v1.0 endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/agreements/{agreementsId}?$expand=files`
GET `/agreements/{agreementsId}/file`
GET `/agreements/{agreementsId}/file/localizations`
GET `/identityGovernance/termsOfUse/agreements`
GET `/identityGovernance/termsOfUse/agreements/{id}`

Exact Microsoft Learn match

Microsoft Graph beta endpoints are mapped directly from refreshed Microsoft Learn permissions tables.

Methods
GET `/agreements/{agreementsId}?$expand=files`
GET `/agreements/{agreementsId}/file`
GET `/agreements/{agreementsId}/file/localizations`
GET `/identityGovernance/termsOfUse/agreements`
GET `/identityGovernance/termsOfUse/agreements/{id}`

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell v1.0 commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgAgreementFile` /agreements/{agreementsId}/file Get agreementFile
`Get-MgAgreementFileLocalization` /agreements/{agreementsId}/file/localizations List agreementFileLocalizations
`Get-MgIdentityGovernanceTermsOfUseAgreement` /agreements/{agreementsId}?$expand=files List files (terms of use agreement files)
`Get-MgIdentityGovernanceTermsOfUseAgreement` /identityGovernance/termsOfUse/agreements List agreements
`Get-MgIdentityGovernanceTermsOfUseAgreement` /identityGovernance/termsOfUse/agreements/{id} Get agreement
`Get-MgIdentityGovernanceTermsOfUseAgreementFile` /agreements/{agreementsId}/file Get agreementFile

Exact Microsoft Learn PowerShell match

Microsoft Graph PowerShell beta commands are mapped directly from refreshed Microsoft Learn PowerShell snippets.

Commands
`Get-MgBetaAgreementFile` /agreements/{agreementsId}/file Get agreementFile
`Get-MgBetaAgreementFileLocalization` /agreements/{agreementsId}/file/localizations List agreementFileLocalizations
`Get-MgBetaIdentityGovernanceTermsOfUseAgreement` /agreements/{agreementsId}?$expand=files List files (terms of use agreement files)
`Get-MgBetaIdentityGovernanceTermsOfUseAgreement` /identityGovernance/termsOfUse/agreements List agreements
`Get-MgBetaIdentityGovernanceTermsOfUseAgreement` /identityGovernance/termsOfUse/agreements/{id} Get agreement
`Get-MgBetaIdentityGovernanceTermsOfUseAgreementFile` /agreements/{agreementsId}/file Get agreementFile

Code Examples

C# / .NET SDK

Get agreement

View official example on Microsoft Learn

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.IdentityGovernance.TermsOfUse.Agreements["{agreement-id}"].GetAsync();

JavaScript

Get agreement

View official example on Microsoft Learn

const options = {
	authProvider,
};

const client = Client.init(options);

let agreement = await client.api('/identityGovernance/termsOfUse/agreements/0ec9f6a6-159d-4dd8-a563-1f0b5935e80b')
	.get();

PowerShell

Get agreement

View official example on Microsoft Learn

Import-Module Microsoft.Graph.Identity.Governance

Get-MgIdentityGovernanceTermsOfUseAgreement -AgreementId $agreementId

Python

Get agreement

View official example on Microsoft Learn

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.identity_governance.terms_of_use.agreements.by_agreement_id('agreement-id').get()

App Registration

1

Navigate to Azure Portal

Go to App registrations in Microsoft Entra admin center

2

Add API Permission

Select your app → API permissions → Add a permission → Microsoft Graph

3

Select Permission Type

Choose Application permissions or delegated permissions and search for Agreement.Read.All

4

Grant Admin Consent

Application permissions always require admin consent.