Microsoft Graph Agreement Acceptances provides a read-only way to retrieve records of users’ responses to your organization’s Terms of Use configured in Microsoft Entra ID. Each acceptance entry is created automatically when a user (including guests) is prompted and captures who responded, which agreement and file version they saw, their response state (accepted or declined), the timestamp, and—if per‑device consent is required—the device information.
openapi: 3.1.0
info:
title: Microsoft Graph Agreement Acceptances API
description: |
Microsoft Graph API for managing agreement acceptances in Microsoft Entra ID.
This API enables organizations to track and manage user acceptances of terms of use agreements,
including viewing acceptance status, managing acceptance records, and querying acceptance history.
version: 1.0.0
contact:
name: Microsoft Graph API Support
url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
description: Microsoft Graph API v1.0 endpoint
tags:
- name: Agreement Acceptances
description: Operations for managing the collection of agreement acceptance entities
- name: Current User Acceptances
description: Operations for managing the current user's agreement acceptances
- name: Identity Governance Acceptances
description: Operations for managing agreement acceptances through identity governance
- name: User Acceptances
description: Operations for managing agreement acceptances for specific users
paths:
/agreementAcceptances:
description: Provides operations to manage the collection of agreementAcceptance entities.
get:
tags:
- Agreement Acceptances
summary: Microsoft Graph List all agreement acceptances
description: Retrieve a list of all agreement acceptance entities in the organization. Supports OData query parameters for filtering, sorting, and pagination.
operationId: listAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Top'
- $ref: '#/components/parameters/Skip'
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/AgreementAcceptanceCollectionResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
post:
tags:
- Agreement Acceptances
summary: Microsoft Graph Create a new agreement acceptance
description: Create a new agreement acceptance entity to record a user's acceptance of an agreement.
operationId: createAgreementAcceptance
requestBody:
description: The agreement acceptance entity to create
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
CreateAgreementAcceptanceRequest:
$ref: '#/components/examples/CreateAgreementAcceptanceRequest'
required: true
responses:
2XX:
description: Created entity
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
CreateAgreementAcceptanceResponse:
$ref: '#/components/examples/CreateAgreementAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/agreementAcceptances/{agreementAcceptance-id}:
description: Provides operations to manage a specific agreementAcceptance entity.
parameters:
- $ref: '#/components/parameters/AgreementAcceptanceId'
get:
tags:
- Agreement Acceptances
summary: Microsoft Graph Get an agreement acceptance by ID
description: Retrieve a specific agreement acceptance entity by its unique identifier.
operationId: getAgreementAcceptance
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
GetAgreementAcceptanceResponse:
$ref: '#/components/examples/GetAgreementAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
patch:
tags:
- Agreement Acceptances
summary: Microsoft Graph Update an agreement acceptance
description: Update the properties of a specific agreement acceptance entity.
operationId: updateAgreementAcceptance
requestBody:
description: New property values for the agreement acceptance
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
UpdateAgreementAcceptanceRequest:
$ref: '#/components/examples/UpdateAgreementAcceptanceRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
UpdateAgreementAcceptanceResponse:
$ref: '#/components/examples/UpdateAgreementAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
delete:
tags:
- Agreement Acceptances
summary: Microsoft Graph Delete an agreement acceptance
description: Delete a specific agreement acceptance entity from the organization.
operationId: deleteAgreementAcceptance
parameters:
- name: If-Match
in: header
description: ETag for optimistic concurrency control
schema:
type: string
responses:
'204':
description: Success - No content returned
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/agreementAcceptances/$count:
description: Get the count of agreement acceptances.
get:
tags:
- Agreement Acceptances
summary: Microsoft Graph Count agreement acceptances
description: Get the total count of agreement acceptance entities in the organization.
operationId: countAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/identityGovernance/termsOfUse/agreementAcceptances:
description: Provides operations to manage agreement acceptances through identity governance.
get:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph List identity governance agreement acceptances
description: Retrieve a list of agreement acceptances through the identity governance terms of use container.
operationId: listIdentityGovernanceAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Top'
- $ref: '#/components/parameters/Skip'
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/AgreementAcceptanceCollectionResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
post:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph Create identity governance agreement acceptance
description: Create a new agreement acceptance through the identity governance terms of use container.
operationId: createIdentityGovernanceAgreementAcceptance
requestBody:
description: The agreement acceptance entity to create
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
CreateIdentityGovernanceAcceptanceRequest:
$ref: '#/components/examples/CreateIdentityGovernanceAcceptanceRequest'
required: true
responses:
2XX:
description: Created navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
CreateIdentityGovernanceAcceptanceResponse:
$ref: '#/components/examples/CreateIdentityGovernanceAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/identityGovernance/termsOfUse/agreementAcceptances/{agreementAcceptance-id}:
description: Provides operations to manage a specific agreement acceptance through identity governance.
parameters:
- $ref: '#/components/parameters/AgreementAcceptanceId'
get:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph Get identity governance agreement acceptance
description: Retrieve a specific agreement acceptance through the identity governance terms of use container.
operationId: getIdentityGovernanceAgreementAcceptance
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
GetIdentityGovernanceAcceptanceResponse:
$ref: '#/components/examples/GetIdentityGovernanceAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
patch:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph Update identity governance agreement acceptance
description: Update the properties of a specific agreement acceptance through the identity governance terms of use container.
operationId: updateIdentityGovernanceAgreementAcceptance
requestBody:
description: New property values for the agreement acceptance
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
UpdateIdentityGovernanceAcceptanceRequest:
$ref: '#/components/examples/UpdateIdentityGovernanceAcceptanceRequest'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
UpdateIdentityGovernanceAcceptanceResponse:
$ref: '#/components/examples/UpdateIdentityGovernanceAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
delete:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph Delete identity governance agreement acceptance
description: Delete a specific agreement acceptance through the identity governance terms of use container.
operationId: deleteIdentityGovernanceAgreementAcceptance
parameters:
- name: If-Match
in: header
description: ETag for optimistic concurrency control
schema:
type: string
responses:
'204':
description: Success - No content returned
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/identityGovernance/termsOfUse/agreementAcceptances/$count:
description: Get the count of identity governance agreement acceptances.
get:
tags:
- Identity Governance Acceptances
summary: Microsoft Graph Count identity governance agreement acceptances
description: Get the total count of agreement acceptances through the identity governance terms of use container.
operationId: countIdentityGovernanceAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/me/agreementAcceptances:
description: Provides operations to manage the current user's agreement acceptances.
get:
tags:
- Current User Acceptances
summary: Microsoft Graph List current user's agreement acceptances
description: Retrieve a list of all agreement acceptances for the currently signed-in user.
operationId: listCurrentUserAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Top'
- $ref: '#/components/parameters/Skip'
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/AgreementAcceptanceCollectionResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/me/agreementAcceptances/{agreementAcceptance-id}:
description: Provides operations to manage a specific agreement acceptance for the current user.
parameters:
- $ref: '#/components/parameters/AgreementAcceptanceId'
get:
tags:
- Current User Acceptances
summary: Microsoft Graph Get current user's agreement acceptance
description: Retrieve a specific agreement acceptance for the currently signed-in user.
operationId: getCurrentUserAgreementAcceptance
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
GetCurrentUserAcceptanceResponse:
$ref: '#/components/examples/GetCurrentUserAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/me/agreementAcceptances/$count:
description: Get the count of the current user's agreement acceptances.
get:
tags:
- Current User Acceptances
summary: Microsoft Graph Count current user's agreement acceptances
description: Get the total count of agreement acceptances for the currently signed-in user.
operationId: countCurrentUserAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/users/{user-id}/agreementAcceptances:
description: Provides operations to manage agreement acceptances for a specific user.
parameters:
- $ref: '#/components/parameters/UserId'
get:
tags:
- User Acceptances
summary: Microsoft Graph List user's agreement acceptances
description: Retrieve a list of all agreement acceptances for a specific user.
operationId: listUserAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Top'
- $ref: '#/components/parameters/Skip'
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
- $ref: '#/components/parameters/Count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: '#/components/responses/AgreementAcceptanceCollectionResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/users/{user-id}/agreementAcceptances/{agreementAcceptance-id}:
description: Provides operations to manage a specific agreement acceptance for a user.
parameters:
- $ref: '#/components/parameters/UserId'
- $ref: '#/components/parameters/AgreementAcceptanceId'
get:
tags:
- User Acceptances
summary: Microsoft Graph Get user's agreement acceptance
description: Retrieve a specific agreement acceptance for a user.
operationId: getUserAgreementAcceptance
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementAcceptance'
examples:
GetUserAcceptanceResponse:
$ref: '#/components/examples/GetUserAcceptanceResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
/users/{user-id}/agreementAcceptances/$count:
description: Get the count of a user's agreement acceptances.
parameters:
- $ref: '#/components/parameters/UserId'
get:
tags:
- User Acceptances
summary: Microsoft Graph Count user's agreement acceptances
description: Get the total count of agreement acceptances for a specific user.
operationId: countUserAgreementAcceptances
parameters:
- $ref: '#/components/parameters/Search'
- $ref: '#/components/parameters/Filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/ErrorResponse'
5XX:
$ref: '#/components/responses/ErrorResponse'
x-ms-docs-operation-type: operation
x-microcks-operation:
delay: 100
dispatcher: FALLBACK
dispatcherRules: default
components:
schemas:
Entity:
title: Entity
type: object
properties:
id:
type: string
description: The unique identifier for an entity. Read-only.
'@odata.type':
type: string
AgreementAcceptance:
allOf:
- $ref: '#/components/schemas/Entity'
- title: AgreementAcceptance
required:
- '@odata.type'
type: object
properties:
agreementFileId:
type: string
description: The identifier of the agreement file accepted by the user.
nullable: true
agreementId:
type: string
description: The identifier of the agreement.
nullable: true
deviceDisplayName:
type: string
description: The display name of the device used for accepting the agreement.
nullable: true
deviceId:
type: string
description: The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
nullable: true
deviceOSType:
type: string
description: The operating system used to accept the agreement.
nullable: true
deviceOSVersion:
type: string
description: The operating system version of the device used to accept the agreement.
nullable: true
expirationDateTime:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: The expiration date time of the acceptance. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
format: date-time
nullable: true
recordedDateTime:
pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$
type: string
description: The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
format: date-time
nullable: true
state:
anyOf:
- $ref: '#/components/schemas/AgreementAcceptanceState'
- type: object
nullable: true
description: The state of the agreement acceptance. The possible values are accepted, declined. Supports $filter (eq).
userDisplayName:
type: string
description: Display name of the user when the acceptance was recorded.
nullable: true
userEmail:
type: string
description: Email of the user when the acceptance was recorded.
nullable: true
userId:
type: string
description: The identifier of the user who accepted the agreement. Supports $filter (eq).
nullable: true
userPrincipalName:
type: string
description: UPN of the user when the acceptance was recorded.
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.agreementAcceptance'
AgreementAcceptanceState:
title: AgreementAcceptanceState
type: string
enum:
- accepted
- declined
description: The state of the agreement acceptance.
AgreementAcceptanceCollectionResponse:
title: AgreementAcceptanceCollectionResponse
type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/AgreementAcceptance'
'@odata.nextLink':
type: string
nullable: true
'@odata.count':
type: integer
format: int32
ODataCountResponse:
type: integer
format: int32
ODataError:
title: ODataError
required:
- error
type: object
properties:
error:
$ref: '#/components/schemas/MainError'
MainError:
title: MainError
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
x-ms-primary-error-message: true
target:
type: string
nullable: true
details:
type: array
items:
$ref: '#/components/schemas/ErrorDetail'
innerError:
$ref: '#/components/schemas/InnerError'
ErrorDetail:
title: ErrorDetail
required:
- code
- message
type: object
properties:
code:
type: string
message:
type: string
target:
type: string
nullable: true
InnerError:
title: InnerError
type: object
description: The structure of this object is service-specific
parameters:
Top:
name: $top
in: query
description: Show only the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
example: 50
Skip:
name: $skip
in: query
description: Skip the first n items
style: form
explode: false
schema:
minimum: 0
type: integer
Search:
name: $search
in: query
description: Search items by search phrases
style: form
explode: false
schema:
type: string
Filter:
name: $filter
in: query
description: Filter items by property values
style: form
explode: false
schema:
type: string
Count:
name: $count
in: query
description: Include count of items
style: form
explode: false
schema:
type: boolean
AgreementAcceptanceId:
name: agreementAcceptance-id
in: path
description: The unique identifier of the agreement acceptance
required: true
schema:
type: string
x-ms-docs-key-type: agreementAcceptance
UserId:
name: user-id
in: path
description: The unique identifier of the user
required: true
schema:
type: string
x-ms-docs-key-type: user
examples:
CreateAgreementAcceptanceReque
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/agreementacceptances-openapi-original.yml