Microsoft

Microsoft Graph: Identity governance

Entitlement management (access packages and assignments), access reviews, privileged identity management, lifecycle workflows and terms of use. This listing…

Identity & security#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Entitlement management (access packages and assignments), access reviews, privileged identity management, lifecycle workflows and terms of use.

This listing is one area of Microsoft Graph, the single REST API for Microsoft 365, Outlook, OneDrive, Teams and Microsoft Entra ID. It holds 400 of the area's requests, the most direct ones first, generated from Microsoft's own OpenAPI description of Graph v1.0. The other areas (mail, calendar, files, Teams, users and more) are listed separately on the Microsoft page.

Get an access token

  1. Sign in to the Microsoft Entra admin center and open App registrations > New registration. For a quick test, the Graph Explorer signs you in and shows a token without registering anything.
  2. Under API permissions, add the Microsoft Graph permissions this area needs, for example: EntitlementManagement.ReadWrite.All, AccessReview.ReadWrite.All, LifecycleWorkflows.ReadWrite.All. Delegated permissions act as the signed-in user; application permissions act as the app itself and need an administrator's consent.
  3. Under Certificates & secrets, create a client secret (keep it out of shared collections).
  4. Get a token from https://login.microsoftonline.com/ /oauth2/v2.0/token: the authorization-code flow for a user, or grant_type=client_credentials with scope=https://graph.microsoft.com/.default for an app. Send it as Authorization: Bearer .

Using these requests

  • Base URL: https://graph.microsoft.com/v1.0. /me/... paths act on the signed-in user; with an application token use /users/{id or userPrincipalName}/... instead.
  • Shape responses with OData query parameters: $select (fields), $filter, $orderby, $top, $expand and $search (some need the ConsistencyLevel: eventual header). Long lists are paged: follow @odata.nextLink.
  • Combine up to 20 requests in one call with POST /$batch.

Common errors

StatusCodeWhat to do
401InvalidAuthenticationTokenThe token is missing, expired or for another resource: get a new one for https://graph.microsoft.com.
403Authorization_RequestDenied / ErrorAccessDeniedAdd the permission listed in the request's docs and grant consent.
404ResourceNotFound / itemNotFoundCheck the id; ids from another user or tenant are not found.
429TooManyRequestsThrottled: wait the Retry-After seconds, then retry.

Docs: Identity governance overview · Permissions reference · Throttling

Endpoints 400

Agreements

  • GETList agreements/agreements
  • POSTCreate agreement/agreements
  • GETGet agreement/agreements/:agreement-id
  • DELETEDelete agreement/agreements/:agreement-id
  • PATCHUpdate agreement/agreements/:agreement-id

Identity governance

  • GETGet identity governance/identityGovernance
  • PATCHUpdate identity governance/identityGovernance

Agreement acceptances

  • GETList agreement acceptances/agreementAcceptances
  • POSTCreate agreement acceptance/agreementAcceptances
  • GETGet agreement acceptance/agreementAcceptances/:agreementAcceptance-id
  • DELETEDelete agreement acceptance/agreementAcceptances/:agreementAcceptance-id
  • PATCHUpdate agreement acceptance/agreementAcceptances/:agreementAcceptance-id

Identity governance: catalogs

  • GETList catalogs/identityGovernance/catalogs
  • POSTCreate catalog/identityGovernance/catalogs
  • GETGet catalog/identityGovernance/catalogs/:accessPackageCatalog-id
  • DELETEDelete catalog/identityGovernance/catalogs/:accessPackageCatalog-id
  • PATCHUpdate catalog/identityGovernance/catalogs/:accessPackageCatalog-id
  • GETList resources/identityGovernance/catalogs/:accessPackageCatalog-id/resourcesAccess package resources in this catalog.
  • POSTCreate resource/identityGovernance/catalogs/:accessPackageCatalog-id/resources
  • GETList resource roles/identityGovernance/catalogs/:accessPackageCatalog-id/resourceRoles
  • POSTCreate resource role/identityGovernance/catalogs/:accessPackageCatalog-id/resourceRoles
  • GETList access packages/identityGovernance/catalogs/:accessPackageCatalog-id/accessPackagesThe access packages in this catalog. Read-only. Nullable.
  • GETList resource scopes/identityGovernance/catalogs/:accessPackageCatalog-id/resourceScopes
  • POSTCreate resource scope/identityGovernance/catalogs/:accessPackageCatalog-id/resourceScopes
  • GETList custom workflow extensions/identityGovernance/catalogs/:accessPackageCatalog-id/customWorkflowExtensions
  • POSTCreate custom workflow extension/identityGovernance/catalogs/:accessPackageCatalog-id/customWorkflowExtensions
  • GETGet access package/identityGovernance/catalogs/:accessPackageCatalog-id/accessPackages/:accessPackage-idThe access packages in this catalog. Read-only. Nullable.
  • GETGet resource/identityGovernance/catalogs/:accessPackageCatalog-id/resources/:accessPackageResource-idAccess package resources in this catalog.
  • DELETEDelete resource/identityGovernance/catalogs/:accessPackageCatalog-id/resources/:accessPackageResource-id
  • PATCHUpdate resource/identityGovernance/catalogs/:accessPackageCatalog-id/resources/:accessPackageResource-id
  • GETGet resource role/identityGovernance/catalogs/:accessPackageCatalog-id/resourceRoles/:accessPackageResourceRole-id
  • DELETEDelete resource role/identityGovernance/catalogs/:accessPackageCatalog-id/resourceRoles/:accessPackageResourceRole-id
  • PATCHUpdate resource role/identityGovernance/catalogs/:accessPackageCatalog-id/resourceRoles/:accessPackageResourceRole-id
  • GETGet resource scope/identityGovernance/catalogs/:accessPackageCatalog-id/resourceScopes/:accessPackageResourceScope-id
  • DELETEDelete resource scope/identityGovernance/catalogs/:accessPackageCatalog-id/resourceScopes/:accessPackageResourceScope-id
  • PATCHUpdate resource scope/identityGovernance/catalogs/:accessPackageCatalog-id/resourceScopes/:accessPackageResourceScope-id
  • GETGet custom workflow extension/identityGovernance/catalogs/:accessPackageCatalog-id/customWorkflowExtensions/:customCalloutExtension-id
  • DELETEDelete custom workflow extension/identityGovernance/catalogs/:accessPackageCatalog-id/customWorkflowExtensions/:customCalloutExtension-id
  • PATCHUpdate custom workflow extension/identityGovernance/catalogs/:accessPackageCatalog-id/customWorkflowExtensions/:customCalloutExtension-id

Identity governance: app consent

  • GETGet app consent/identityGovernance/appConsent
  • DELETEDelete app consent/identityGovernance/appConsent
  • PATCHUpdate app consent/identityGovernance/appConsent
  • GETList app consent requests/identityGovernance/appConsent/appConsentRequestsRetrieve appConsentRequest objects and their properties.
  • POSTCreate app consent request/identityGovernance/appConsent/appConsentRequests
  • GETGet app consent request/identityGovernance/appConsent/appConsentRequests/:appConsentRequest-idRead the properties and relationships of an appConsentRequest object.
  • DELETEDelete app consent request/identityGovernance/appConsent/appConsentRequests/:appConsentRequest-id
  • PATCHUpdate app consent request/identityGovernance/appConsent/appConsentRequests/:appConsentRequest-id
  • GETGet app consent request/identityGovernance/appConsent/appConsentRequests/filterByCurrentUser(on=':on')Retrieve a collection of appConsentRequest objects for which the current user is the reviewer and the status of the userConsentRequest for accessing the…
  • GETList user consent requests/identityGovernance/appConsent/appConsentRequests/:appConsentRequest-id/userConsentRequestsRetrieve a collection of userConsentRequest objects and their properties.
  • POSTCreate user consent request/identityGovernance/appConsent/appConsentRequests/:appConsentRequest-id/userConsentRequests

Identity governance: terms of use

  • GETGet terms of use/identityGovernance/termsOfUse
  • DELETEDelete terms of use/identityGovernance/termsOfUse
  • PATCHUpdate terms of use/identityGovernance/termsOfUse
  • GETList agreements/identityGovernance/termsOfUse/agreementsRetrieve a list of agreement objects.
  • POSTCreate agreement/identityGovernance/termsOfUse/agreementsCreate a new agreement object.
  • GETList agreement acceptances/identityGovernance/termsOfUse/agreementAcceptancesRepresents the current status of a user's response to a company's customizable terms of use agreement.
  • POSTCreate agreement acceptance/identityGovernance/termsOfUse/agreementAcceptances
  • GETGet agreement/identityGovernance/termsOfUse/agreements/:agreement-idRetrieve the properties and relationships of an agreement object.
  • DELETEDelete agreement/identityGovernance/termsOfUse/agreements/:agreement-idDelete an agreement object.
  • PATCHUpdate agreement/identityGovernance/termsOfUse/agreements/:agreement-idUpdate the properties of an agreement object.
  • GETGet agreement acceptance/identityGovernance/termsOfUse/agreementAcceptances/:agreementAcceptance-idRepresents the current status of a user's response to a company's customizable terms of use agreement.
  • DELETEDelete agreement acceptance/identityGovernance/termsOfUse/agreementAcceptances/:agreementAcceptance-id
  • PATCHUpdate agreement acceptance/identityGovernance/termsOfUse/agreementAcceptances/:agreementAcceptance-id
  • GETGet file/identityGovernance/termsOfUse/agreements/:agreement-id/fileRetrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own…
  • DELETEDelete file/identityGovernance/termsOfUse/agreements/:agreement-id/file
  • PATCHUpdate file/identityGovernance/termsOfUse/agreements/:agreement-id/file
  • GETList files/identityGovernance/termsOfUse/agreements/:agreement-id/filesPDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
  • POSTCreate file/identityGovernance/termsOfUse/agreements/:agreement-id/filesCreate a new localized agreement file.
  • GETList acceptances/identityGovernance/termsOfUse/agreements/:agreement-id/acceptancesGet the details about the acceptance records for a specific agreement.
  • POSTCreate acceptance/identityGovernance/termsOfUse/agreements/:agreement-id/acceptances

Identity governance: access reviews

  • GETList access reviews/identityGovernance/accessReviews
  • DELETEDelete access reviews/identityGovernance/accessReviews
  • PATCHUpdate access reviews/identityGovernance/accessReviews
  • GETGet unified/identityGovernance/accessReviews/unifiedEntry point for the unified (vNext) access reviews API surface. Requests under this path are routed to the vNext service through the dedicated…
  • DELETEDelete unified/identityGovernance/accessReviews/unified
  • PATCHUpdate unified/identityGovernance/accessReviews/unified
  • GETList definitions/identityGovernance/accessReviews/definitionsGet a list of the accessReviewScheduleDefinition objects and their properties.
  • POSTCreate definition/identityGovernance/accessReviews/definitionsCreate a new accessReviewScheduleDefinition object.
  • GETList history definitions/identityGovernance/accessReviews/historyDefinitionsRetrieve the accessReviewHistoryDefinition objects created in the last 30 days, including all nested properties.
  • POSTCreate history definition/identityGovernance/accessReviews/historyDefinitionsCreate a new accessReviewHistoryDefinition object.
  • GETList decisions/identityGovernance/accessReviews/unified/decisionsRepresents the unified (vNext) access review decisions on an instance of a review.
  • POSTCreate decision/identityGovernance/accessReviews/unified/decisions
  • GETList instances/identityGovernance/accessReviews/unified/instancesRepresents the unified (vNext) instance of a review.
  • POSTCreate instance/identityGovernance/accessReviews/unified/instances
  • GETList definitions/identityGovernance/accessReviews/unified/definitionsRetrieve the accessReviewScheduleDefinition objects for user-centric (catalog-scope) access reviews through the unified route. A list of zero or more…
  • POSTCreate definition/identityGovernance/accessReviews/unified/definitionsCreate a new user-centric (catalog-scope) accessReviewScheduleDefinition object through the unified route. With a user-centric review, a reviewer evaluates a…
  • GETGet definition/identityGovernance/accessReviews/definitions/filterByCurrentUser(on=':on')Returns accessReviewScheduleDefinition objects where the calling user is a reviewer on one or more accessReviewInstance objects.
  • GETGet definition/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-idRead the properties and relationships of an accessReviewScheduleDefinition object. To retrieve the instances of the access review series, use the list…
  • PUTReplace definition/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-idUpdate an existing accessReviewScheduleDefinition object to change one or more of its properties.
  • DELETEDelete definition/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-idDeletes an accessReviewScheduleDefinition object.
  • GETGet history definition/identityGovernance/accessReviews/historyDefinitions/:accessReviewHistoryDefinition-idRetrieve an accessReviewHistoryDefinition object by its identifier. All the properties of the access review history definition object are returned. If the…
  • DELETEDelete history definition/identityGovernance/accessReviews/historyDefinitions/:accessReviewHistoryDefinition-id
  • PATCHUpdate history definition/identityGovernance/accessReviews/historyDefinitions/:accessReviewHistoryDefinition-id
  • GETGet instance/identityGovernance/accessReviews/unified/instances/:accessReviewInstance-idRepresents the unified (vNext) instance of a review.
  • DELETEDelete instance/identityGovernance/accessReviews/unified/instances/:accessReviewInstance-id
  • PATCHUpdate instance/identityGovernance/accessReviews/unified/instances/:accessReviewInstance-id
  • GETGet decision/identityGovernance/accessReviews/unified/decisions/filterByCurrentUser(on=':on')Retrieve all decision items for an instance of an access review or a stage of an instance of a multi-stage access review for which the calling user is the…
  • GETGet instance/identityGovernance/accessReviews/unified/instances/filterByCurrentUser(on=':on')Retrieve all accessReviewInstance objects on a given accessReviewScheduleDefinition where the calling user is a reviewer on one or more…
  • GETGet definition/identityGovernance/accessReviews/unified/definitions/filterByCurrentUser(on=':on')Returns accessReviewScheduleDefinition objects where the calling user is a reviewer on one or more accessReviewInstance objects.
  • POSTStop definition/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-id/stop
  • GETGet decision/identityGovernance/accessReviews/unified/decisions/:accessReviewInstanceDecisionItem-idRepresents the unified (vNext) access review decisions on an instance of a review.
  • DELETEDelete decision/identityGovernance/accessReviews/unified/decisions/:accessReviewInstanceDecisionItem-id
  • PATCHUpdate decision/identityGovernance/accessReviews/unified/decisions/:accessReviewInstanceDecisionItem-id
  • GETGet definition/identityGovernance/accessReviews/unified/definitions/:accessReviewScheduleDefinition-idRepresents the unified (vNext) template and scheduling for an access review.
  • DELETEDelete definition/identityGovernance/accessReviews/unified/definitions/:accessReviewScheduleDefinition-id
  • PATCHUpdate definition/identityGovernance/accessReviews/unified/definitions/:accessReviewScheduleDefinition-id
  • GETList instances/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-id/instancesGet a list of the accessReviewInstance objects and their properties.
  • POSTCreate instance/identityGovernance/accessReviews/definitions/:accessReviewScheduleDefinition-id/instances
  • GETList instances/identityGovernance/accessReviews/historyDefinitions/:accessReviewHistoryDefinition-id/instancesRetrieve the instances of an access review history definition created in the last 30 days.
  • POSTCreate instance/identityGovernance/accessReviews/historyDefinitions/:accessReviewHistoryDefinition-id/instances

Identity governance: privileged access

  • GETList privileged access/identityGovernance/privilegedAccess
  • DELETEDelete privileged access/identityGovernance/privilegedAccess
  • PATCHUpdate privileged access/identityGovernance/privilegedAccess
  • GETGet group/identityGovernance/privilegedAccess/groupA group that's governed through Privileged Identity Management (PIM).
  • DELETEDelete group/identityGovernance/privilegedAccess/group
  • PATCHUpdate group/identityGovernance/privilegedAccess/group
  • GETList custom extensions/identityGovernance/privilegedAccess/customExtensionsGet a list of roleManagementCustomCalloutExtension objects configured for Privileged Identity Management (PIM).
  • POSTCreate custom extension/identityGovernance/privilegedAccess/customExtensionsCreate a new roleManagementCustomCalloutExtension object for Privileged Identity Management (PIM).
  • GETList resources/identityGovernance/privilegedAccess/group/resourcesGet a list of the groupResource objects and their properties.
  • POSTCreate resource/identityGovernance/privilegedAccess/group/resources
  • GETList assignment approvals/identityGovernance/privilegedAccess/group/assignmentApprovals
  • POSTCreate assignment approval/identityGovernance/privilegedAccess/group/assignmentApprovals
  • GETList assignment schedules/identityGovernance/privilegedAccess/group/assignmentSchedulesGet a list of the privilegedAccessGroupAssignmentSchedule objects and their properties.
  • POSTCreate assignment schedule/identityGovernance/privilegedAccess/group/assignmentSchedules
  • GETList eligibility schedules/identityGovernance/privilegedAccess/group/eligibilitySchedulesGet a list of the privilegedAccessGroupEligibilitySchedule objects and their properties.
  • POSTCreate eligibility schedule/identityGovernance/privilegedAccess/group/eligibilitySchedules
  • GETList assignment schedule requests/identityGovernance/privilegedAccess/group/assignmentScheduleRequestsGet a list of the privilegedAccessGroupAssignmentScheduleRequest objects and their properties.
  • POSTCreate assignment schedule request/identityGovernance/privilegedAccess/group/assignmentScheduleRequestsCreate a new privilegedAccessGroupAssignmentScheduleRequest object.
  • GETList assignment schedule instances/identityGovernance/privilegedAccess/group/assignmentScheduleInstancesGet a list of the privilegedAccessGroupAssignmentScheduleInstance objects and their properties.
  • POSTCreate assignment schedule instance/identityGovernance/privilegedAccess/group/assignmentScheduleInstances
  • GETList eligibility schedule requests/identityGovernance/privilegedAccess/group/eligibilityScheduleRequestsGet a list of the privilegedAccessGroupEligibilityScheduleRequest objects and their properties.
  • POSTCreate eligibility schedule request/identityGovernance/privilegedAccess/group/eligibilityScheduleRequestsCreate a new privilegedAccessGroupEligibilityScheduleRequest object.
  • GETList eligibility schedule instances/identityGovernance/privilegedAccess/group/eligibilityScheduleInstancesGet a list of the privilegedAccessGroupEligibilityScheduleInstance objects and their properties.
  • POSTCreate eligibility schedule instance/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances
  • GETGet custom extension/identityGovernance/privilegedAccess/customExtensions/:roleManagementCustomCalloutExtension-idRetrieve the properties of a roleManagementCustomCalloutExtension object.
  • DELETEDelete custom extension/identityGovernance/privilegedAccess/customExtensions/:roleManagementCustomCalloutExtension-idDelete a roleManagementCustomCalloutExtension object.
  • PATCHUpdate custom extension/identityGovernance/privilegedAccess/customExtensions/:roleManagementCustomCalloutExtension-idUpdate the properties of a roleManagementCustomCalloutExtension object.
  • GETGet resource/identityGovernance/privilegedAccess/group/resources/:groupResource-idRead the properties and relationships of a groupResource object.
  • DELETEDelete resource/identityGovernance/privilegedAccess/group/resources/:groupResource-id
  • PATCHUpdate resource/identityGovernance/privilegedAccess/group/resources/:groupResource-id
  • GETGet assignment approval/identityGovernance/privilegedAccess/group/assignmentApprovals/:approval-id
  • DELETEDelete assignment approval/identityGovernance/privilegedAccess/group/assignmentApprovals/:approval-id
  • PATCHUpdate assignment approval/identityGovernance/privilegedAccess/group/assignmentApprovals/:approval-id
  • GETGet assignment approval/identityGovernance/privilegedAccess/group/assignmentApprovals/filterByCurrentUser(on=':on')In Microsoft Entra entitlement management, return a collection of access package assignment approvals. The objects returned are those that are in scope for…
  • GETGet assignment schedule/identityGovernance/privilegedAccess/group/assignmentSchedules/filterByCurrentUser(on=':on')In PIM for Groups, retrieve the schedules for membership or ownership assignments for the calling principal to groups that are governed by PIM.
  • GETGet eligibility schedule/identityGovernance/privilegedAccess/group/eligibilitySchedules/filterByCurrentUser(on=':on')Retrieve schedules of membership and ownership eligibility requests for the calling principal.
  • GETGet assignment schedule request/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/filterByCurrentUser(on=':on')In PIM for Groups, retrieve the requests for membership or ownership assignments for the calling principal to groups that are governed by PIM.
  • GETGet assignment schedule instance/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/filterByCurrentUser(on=':on')In PIM for Groups, retrieve the schedule instances for membership or ownership assignments for the calling principal to groups that are governed by PIM.
  • GETGet eligibility schedule request/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/filterByCurrentUser(on=':on')In PIM for Groups, retrieve the requests for membership or ownership eligibilities for the calling principal to groups that are governed by PIM.
  • GETGet eligibility schedule instance/identityGovernance/privilegedAccess/group/eligibilityScheduleInstances/filterByCurrentUser(on=':on')Return instances of membership and ownership eligibility schedules for the calling principal.
  • GETGet assignment schedule/identityGovernance/privilegedAccess/group/assignmentSchedules/:privilegedAccessGroupAssignmentSchedule-idRead the properties and relationships of a privilegedAccessGroupAssignmentSchedule object.
  • DELETEDelete assignment schedule/identityGovernance/privilegedAccess/group/assignmentSchedules/:privilegedAccessGroupAssignmentSchedule-id
  • PATCHUpdate assignment schedule/identityGovernance/privilegedAccess/group/assignmentSchedules/:privilegedAccessGroupAssignmentSchedule-id
  • GETGet eligibility schedule/identityGovernance/privilegedAccess/group/eligibilitySchedules/:privilegedAccessGroupEligibilitySchedule-idRead the properties and relationships of a privilegedAccessGroupEligibilitySchedule object.
  • DELETEDelete eligibility schedule/identityGovernance/privilegedAccess/group/eligibilitySchedules/:privilegedAccessGroupEligibilitySchedule-id
  • PATCHUpdate eligibility schedule/identityGovernance/privilegedAccess/group/eligibilitySchedules/:privilegedAccessGroupEligibilitySchedule-id
  • GETGet assignment schedule request/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/:privilegedAccessGroupAssignmentScheduleRequest-idRead the properties and relationships of a privilegedAccessGroupAssignmentScheduleRequest object.
  • DELETEDelete assignment schedule request/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/:privilegedAccessGroupAssignmentScheduleRequest-id
  • PATCHUpdate assignment schedule request/identityGovernance/privilegedAccess/group/assignmentScheduleRequests/:privilegedAccessGroupAssignmentScheduleRequest-id
  • GETGet assignment schedule instance/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/:privilegedAccessGroupAssignmentScheduleInstance-idRead the properties and relationships of a privilegedAccessGroupAssignmentScheduleInstance object.
  • DELETEDelete assignment schedule instance/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/:privilegedAccessGroupAssignmentScheduleInstance-id
  • PATCHUpdate assignment schedule instance/identityGovernance/privilegedAccess/group/assignmentScheduleInstances/:privilegedAccessGroupAssignmentScheduleInstance-id
  • GETGet eligibility schedule request/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/:privilegedAccessGroupEligibilityScheduleRequest-idRead the properties and relationships of a privilegedAccessGroupEligibilityScheduleRequest object.
  • DELETEDelete eligibility schedule request/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/:privilegedAccessGroupEligibilityScheduleRequest-id
  • PATCHUpdate eligibility schedule request/identityGovernance/privilegedAccess/group/eligibilityScheduleRequests/:privilegedAccessGroupEligibilityScheduleRequest-id

Identity governance: lifecycle workflows

  • GETList lifecycle workflows/identityGovernance/lifecycleWorkflows
  • DELETEDelete lifecycle workflows/identityGovernance/lifecycleWorkflows
  • PATCHUpdate lifecycle workflows/identityGovernance/lifecycleWorkflows
  • GETList insights/identityGovernance/lifecycleWorkflows/insightsThe insight container holding workflow insight summaries for a tenant.
  • DELETEDelete insights/identityGovernance/lifecycleWorkflows/insights
  • PATCHUpdate insights/identityGovernance/lifecycleWorkflows/insights
  • GETGet settings/identityGovernance/lifecycleWorkflows/settingsRead the properties and relationships of a lifecycleManagementSettings object.
  • PATCHUpdate settings/identityGovernance/lifecycleWorkflows/settingsUpdate the properties of a lifecycleManagementSettings object.
  • GETList workflows/identityGovernance/lifecycleWorkflows/workflowsGet a list of workflow resources that are associated with Lifecycle Workflows.
  • POSTCreate workflow/identityGovernance/lifecycleWorkflows/workflowsCreate a new workflow object. You can create up to 100 workflows in a tenant.
  • GETList deleted items/identityGovernance/lifecycleWorkflows/deletedItemsDeleted workflows in your lifecycle workflows instance.
  • DELETEDelete deleted items/identityGovernance/lifecycleWorkflows/deletedItems
  • GETList task definitions/identityGovernance/lifecycleWorkflows/taskDefinitionsGet a list of built-in tasks in Lifecycle Workflows. A task is represented by the taskDefinition object.
  • GETList workflow templates/identityGovernance/lifecycleWorkflows/workflowTemplatesGet a list of the workflowTemplate objects and their properties.
  • GETList custom task extensions/identityGovernance/lifecycleWorkflows/customTaskExtensionsGet a list of the customTaskExtension objects and their properties.
  • POSTCreate custom task extension/identityGovernance/lifecycleWorkflows/customTaskExtensionsCreate a new customTaskExtension object.
  • GETList workflows/identityGovernance/lifecycleWorkflows/deletedItems/workflowsGet a list of deleted workflow objects and their properties from the deletedItemContainer.
  • GETGet workflow/identityGovernance/lifecycleWorkflows/workflows/:workflow-idRead the properties and relationships of a workflow object.
  • DELETEDelete workflow/identityGovernance/lifecycleWorkflows/workflows/:workflow-idDelete a workflow object and its associated tasks, taskProcessingResults and versions. The deleted workflow is sent to the deleted workflows container. You…
  • PATCHUpdate workflow/identityGovernance/lifecycleWorkflows/workflows/:workflow-idUpdate the properties of a workflow object. Only the properties listed in the request body table can be updated. To update any other workflow properties, see…
  • GETGet task definition/identityGovernance/lifecycleWorkflows/taskDefinitions/:taskDefinition-idRead the details of a built-in workflow task in Lifecycle Workflows.
  • GETGet workflow template/identityGovernance/lifecycleWorkflows/workflowTemplates/:workflowTemplate-idRead the properties and relationships of a workflowTemplate object.
  • GETGet custom task extension/identityGovernance/lifecycleWorkflows/customTaskExtensions/:customTaskExtension-idRead the properties and relationships of a customTaskExtension object.
  • DELETEDelete custom task extension/identityGovernance/lifecycleWorkflows/customTaskExtensions/:customTaskExtension-idDelete a customTaskExtension object. A custom task extension can only be deleted if it is not referenced in any task objects in a lifecycle workflow.
  • PATCHUpdate custom task extension/identityGovernance/lifecycleWorkflows/customTaskExtensions/:customTaskExtension-idUpdate the properties of a customTaskExtension object.
  • GETIdentity governance.top tasks processed summary (insight)/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.topTasksProcessedSummary(startDateTime=:startDateTime,endDateTime=:endDateTime)Provide a summary from the insights resource of the most processed task objects, known as top tasks, for a specified time period in a tenant. The task…
  • GETIdentity governance.workflows processed summary (insight)/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.workflowsProcessedSummary(startDateTime=:startDateTime,endDateTime=:endDateTime)Provide a summary from the insights resource of workflow objects processed within a tenant for a specified period. Because the list returned by List workflows…
  • GETIdentity governance.top workflows processed summary (insight)/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.topWorkflowsProcessedSummary(startDateTime=:startDateTime,endDateTime=:endDateTime)Provide a summary from the insights resource of the workflow objects processed the most, known as top workflows, for a specified period in a tenant. Workflow…
  • GETIdentity governance.workflows processed by category (insight)/identityGovernance/lifecycleWorkflows/insights/microsoft.graph.identityGovernance.workflowsProcessedByCategory(startDateTime=:startDateTime,endDateTime=:endDateTime)Provide a summary from the insights resource of workflow objects processed by category in a tenant. This allows you to quickly get category information, by…
  • GETList runs/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/runsGet a list of run objects and their properties for a workflow.
  • GETList tasks/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/tasksRetrieve the details of the built-in task objects in a workflow.
  • POSTCreate task/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/tasks
  • GETList versions/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/versionsGet a list of the workflowVersion objects and their properties.
  • GETGet created by/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/createdByThe user who created the workflow.
  • GETList task reports/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/taskReportsGet a list of the taskReport objects and their properties.
  • GETGet workflow/identityGovernance/lifecycleWorkflows/deletedItems/workflows/:workflow-idRetrieve a deleted workflow object.
  • DELETEDelete workflow/identityGovernance/lifecycleWorkflows/deletedItems/workflows/:workflow-idDelete a workflow object.
  • GETPreview scope (workflow)/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/previewScopeThe preview scope for the workflow.
  • GETGet execution scope/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/executionScopeThe list of users that meet the workflowExecutionConditions of a workflow.
  • GETGet last modified by/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/lastModifiedByThe unique identifier of the Microsoft Entra identity that last modified the workflow.
  • GETList tasks/identityGovernance/lifecycleWorkflows/workflowTemplates/:workflowTemplate-id/tasksRepresents the configured tasks to execute and their execution sequence within a workflow. This relationship is expanded by default.
  • GETList user processing results/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/userProcessingResultsGet the userProcessingResult resources for a workflow.
  • GETList subject processing results/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/subjectProcessingResultsPer-subject workflow execution results.
  • GETList administration scope targets/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/administrationScopeTargetsThe administrative units in the scope of the workflow. Optional. Supports $expand.
  • GETGet created by/identityGovernance/lifecycleWorkflows/customTaskExtensions/:customTaskExtension-id/createdByThe unique identifier of the Microsoft Entra user that created the custom task extension.Supports $filter(eq, ne) and $expand.
  • GETGet last modified by/identityGovernance/lifecycleWorkflows/customTaskExtensions/:customTaskExtension-id/lastModifiedByThe unique identifier of the Microsoft Entra user that modified the custom task extension last.Supports $filter(eq, ne) and $expand.
  • POSTCreate identity governance.restore/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.restoreRestore a deleted workflow object. You can only restore a workflow that was deleted within the last 30 days before Microsoft Entra ID automatically…
  • POSTCreate identity governance.activate/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.activateRun a workflow object on-demand. You can run any workflow on-demand, including scheduled workflows. Workflows created from the 'Real-time employee…
  • POSTCreate identity governance.activate and wait/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.activateAndWaitActivate a lifecycle workflow for a specified subject and synchronously wait for execution to complete. This action returns an awaitedWorkflowProcessingResult…
  • POSTCreate identity governance.clear quarantine/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.clearQuarantineRelease a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in…
  • POSTCreate identity governance.preview workflow/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.previewWorkflowRun a workflow in preview mode for selected directory objects without affecting production users. This action triggers workflow processing in preview mode,…
  • POSTCreate identity governance.cancel processing/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.cancelProcessingCancel one or more workflow runs that are currently in queued or inProgress status. Currently limited to canceling one run per request.
  • POSTCreate identity governance.create new version/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.createNewVersionCreate a new version of the workflow object.
  • POSTCreate identity governance.activate with scope/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.activateWithScopeRun a workflow object on-demand with a specific scope. You can run any workflow on-demand, including scheduled workflows. Workflows created from the…
  • POSTCreate identity governance.preview task failure/identityGovernance/lifecycleWorkflows/workflows/:workflow-id/microsoft.graph.identityGovernance.previewTaskFailuresValidate the tasks configured in a workflow to check for configuration errors. This action identifies any tasks that would fail during execution, allowing you…

Identity governance: entitlement management

  • GETGet entitlement management/identityGovernance/entitlementManagement
  • DELETEDelete entitlement management/identityGovernance/entitlementManagement
  • PATCHUpdate entitlement management/identityGovernance/entitlementManagement
  • GETList catalogs/identityGovernance/entitlementManagement/catalogsRetrieve a list of accessPackageCatalog objects.
  • POSTCreate catalog/identityGovernance/entitlementManagement/catalogsCreate a new accessPackageCatalog object.
  • GETGet settings/identityGovernance/entitlementManagement/settingsRetrieve the properties of an entitlementManagementSettings object.
  • DELETEDelete settings/identityGovernance/entitlementManagement/settings
  • PATCHUpdate settings/identityGovernance/entitlementManagement/settingsUpdate an existing entitlementManagementSettings object to change one or more of its properties.
  • GETList subjects/identityGovernance/entitlementManagement/subjectsGet the properties of an external directory user represented by an existing accessPackageSubject object.
  • POSTCreate subject/identityGovernance/entitlementManagement/subjects
  • GETList resources/identityGovernance/entitlementManagement/resourcesThe resources associated with the catalogs.
  • POSTCreate resource/identityGovernance/entitlementManagement/resources
  • GETList assignments/identityGovernance/entitlementManagement/assignmentsIn Microsoft Entra entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes…
  • POSTCreate assignment/identityGovernance/entitlementManagement/assignments
  • GETList access packages/identityGovernance/entitlementManagement/accessPackagesRetrieve a list of accessPackage objects. The resulting list includes all the access packages that the caller has access to read, across all catalogs.
  • POSTCreate access package/identityGovernance/entitlementManagement/accessPackagesCreate a new accessPackage object. The access package will be added to an existing accessPackageCatalog.
  • GETList resource requests/identityGovernance/entitlementManagement/resourceRequestsRetrieve a list of accessPackageResourceRequest objects.
  • POSTCreate resource request/identityGovernance/entitlementManagement/resourceRequestsCreate a new accessPackageResourceRequest object to request the addition of a resource to an access package catalog, update of a resource, or the removal of a…
  • GETList assignment policies/identityGovernance/entitlementManagement/assignmentPoliciesRetrieve a list of accessPackageAssignmentPolicy objects in Microsoft Entra entitlement management. If the delegated user is in a directory role, the…
  • POSTCreate assignment policy/identityGovernance/entitlementManagement/assignmentPoliciesCreate a new accessPackageAssignmentPolicy object in Microsoft Entra entitlement management. The request includes a reference to the accessPackage that…
  • GETList assignment requests/identityGovernance/entitlementManagement/assignmentRequestsIn Microsoft Entra entitlement management, retrieve a list of accessPackageAssignmentRequest objects. The resulting list includes all the assignment requests,…
  • POSTCreate assignment request/identityGovernance/entitlementManagement/assignmentRequestsIn Microsoft Entra Entitlement Management, create a new accessPackageAssignmentRequest object. This operation is used to assign a user to an access package,…
  • GETList resource role scopes/identityGovernance/entitlementManagement/resourceRoleScopes
  • POSTCreate resource role scope/identityGovernance/entitlementManagement/resourceRoleScopes
  • GETList resource environments/identityGovernance/entitlementManagement/resourceEnvironmentsRetrieve a list of accessPackageResourceEnvironment objects and their properties.
  • POSTCreate resource environment/identityGovernance/entitlementManagement/resourceEnvironments
  • GETList control configurations/identityGovernance/entitlementManagement/controlConfigurationsConfiguration settings that control the lifecycle and access policies of entitlement management within a tenant.
  • POSTCreate control configuration/identityGovernance/entitlementManagement/controlConfigurations
  • GETList connected organizations/identityGovernance/entitlementManagement/connectedOrganizationsRetrieve a list of connectedOrganization objects.
  • POSTCreate connected organization/identityGovernance/entitlementManagement/connectedOrganizationsCreate a new connectedOrganization object.
  • GETList available access packages/identityGovernance/entitlementManagement/availableAccessPackagesAccess packages available for end users to browse and request.
  • POSTCreate available access package/identityGovernance/entitlementManagement/availableAccessPackages
  • GETList access package suggestions/identityGovernance/entitlementManagement/accessPackageSuggestionsSuggested access packages for end users based on various criteria such as related people insights and assignment history.
  • POSTCreate access package suggestion/identityGovernance/entitlementManagement/accessPackageSuggestions
  • GETList access package assignment approvals/identityGovernance/entitlementManagement/accessPackageAssignmentApprovalsRetrieve the properties of an approval object. This API request is made by an approver in the following scenarios: In Microsoft Entra entitlement management,…
  • POSTCreate access package assignment approval/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals
  • GETList external origin resource connectors/identityGovernance/entitlementManagement/externalOriginResourceConnectorsGet a list of externalOriginResourceConnector objects and their properties.
  • POSTCreate external origin resource connector/identityGovernance/entitlementManagement/externalOriginResourceConnectorsCreates a new externalOriginResourceConnector object.
  • GETGet entitlement management/identityGovernance/entitlementManagement/subjects(objectId=':objectId')
  • DELETEDelete entitlement management/identityGovernance/entitlementManagement/subjects(objectId=':objectId')
  • PATCHUpdate entitlement management/identityGovernance/entitlementManagement/subjects(objectId=':objectId')Update an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.
  • GETAdditional access (assignment)/identityGovernance/entitlementManagement/assignments/additionalAccess()In Microsoft Entra Entitlement Management, retrieve a collection of accessPackageAssignment objects that indicate a target user has an assignment to a…
  • GETGet access package/identityGovernance/entitlementManagement/accessPackages/:accessPackage-idRetrieve the properties and relationships of an accessPackage object.
  • DELETEDelete access package/identityGovernance/entitlementManagement/accessPackages/:accessPackage-idDelete an accessPackage object. You cannot delete an access package if it has any accessPackageAssignment.
  • PATCHUpdate access package/identityGovernance/entitlementManagement/accessPackages/:accessPackage-idUpdate an existing accessPackage object to change one or more of its properties, such as the display name or description.
  • GETGet catalog/identityGovernance/entitlementManagement/catalogs/:accessPackageCatalog-idRetrieve the properties and relationships of an accessPackageCatalog object.
  • DELETEDelete catalog/identityGovernance/entitlementManagement/catalogs/:accessPackageCatalog-idDelete an accessPackageCatalog.
  • PATCHUpdate catalog/identityGovernance/entitlementManagement/catalogs/:accessPackageCatalog-idUpdate an existing accessPackageCatalog object to change one or more of its properties, such as the display name or description.
  • GETGet subject/identityGovernance/entitlementManagement/subjects/:accessPackageSubject-id
  • DELETEDelete subject/identityGovernance/entitlementManagement/subjects/:accessPackageSubject-id
  • PATCHUpdate subject/identityGovernance/entitlementManagement/subjects/:accessPackageSubject-idUpdate an external directory user represented by an existing accessPackageSubject object to change the subject lifecycle.
  • GETGet resource/identityGovernance/entitlementManagement/resources/:accessPackageResource-idThe resources associated with the catalogs.
  • DELETEDelete resource/identityGovernance/entitlementManagement/resources/:accessPackageResource-id
  • PATCHUpdate resource/identityGovernance/entitlementManagement/resources/:accessPackageResource-id
  • GETGet assignment/identityGovernance/entitlementManagement/assignments/:accessPackageAssignment-idIn Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignment object.
  • DELETEDelete assignment/identityGovernance/entitlementManagement/assignments/:accessPackageAssignment-id
  • PATCHUpdate assignment/identityGovernance/entitlementManagement/assignments/:accessPackageAssignment-id
  • GETGet assignment/identityGovernance/entitlementManagement/assignments/filterByCurrentUser(on=':on')In Microsoft Entra Entitlement Management, retrieve a list of accessPackageAssignment objects filtered on the signed-in user.
  • GETGet access package/identityGovernance/entitlementManagement/accessPackages/filterByCurrentUser(on=':on')In Microsoft Entra Entitlement Management, retrieve a list of accessPackage objects filtered on the signed-in user.
  • GETGet access package assignment approval/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/:approval-idRetrieve the properties of an approval object. This API request is made by an approver in the following scenarios: In Microsoft Entra entitlement management,…
  • DELETEDelete access package assignment approval/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/:approval-id
  • PATCHUpdate access package assignment approval/identityGovernance/entitlementManagement/accessPackageAssignmentApprovals/:approval-id
  • GETGet control configuration/identityGovernance/entitlementManagement/controlConfigurations/:controlConfiguration-idConfiguration settings that control the lifecycle and access policies of entitlement management within a tenant.
  • PUTReplace control configuration/identityGovernance/entitlementManagement/controlConfigurations/:controlConfiguration-id
  • DELETEDelete control configuration/identityGovernance/entitlementManagement/controlConfigurations/:controlConfiguration-id
  • GETGet assignment request/identityGovernance/entitlementManagement/assignmentRequests/filterByCurrentUser(on=':on')In Microsoft Entra Entitlement Management, retrieve a list of accessPackageAssignmentRequest objects filtered on the signed-in user.
  • GETGet connected organization/identityGovernance/entitlementManagement/connectedOrganizations/:connectedOrganization-idRetrieve the properties and relationships of a connectedOrganization object.
  • DELETEDelete connected organization/identityGovernance/entitlementManagement/connectedOrganizations/:connectedOrganization-idDelete a connectedOrganization object.
  • PATCHUpdate connected organization/identityGovernance/entitlementManagement/connectedOrganizations/:connectedOrganization-idUpdate a connectedOrganization object to change one or more of its properties.
  • GETGet resource request/identityGovernance/entitlementManagement/resourceRequests/:accessPackageResourceRequest-idRepresents a request to add or remove a resource to or from a catalog respectively.
  • DELETEDelete resource request/identityGovernance/entitlementManagement/resourceRequests/:accessPackageResourceRequest-id
  • PATCHUpdate resource request/identityGovernance/entitlementManagement/resourceRequests/:accessPackageResourceRequest-id
  • GETGet available access package/identityGovernance/entitlementManagement/availableAccessPackages/:availableAccessPackage-idAccess packages available for end users to browse and request.
  • DELETEDelete available access package/identityGovernance/entitlementManagement/availableAccessPackages/:availableAccessPackage-id
  • PATCHUpdate available access package/identityGovernance/entitlementManagement/availableAccessPackages/:availableAccessPackage-id
  • GETGet access package suggestion/identityGovernance/entitlementManagement/accessPackageSuggestions/:accessPackageSuggestion-idSuggested access packages for end users based on various criteria such as related people insights and assignment history.
  • DELETEDelete access package suggestion/identityGovernance/entitlementManagement/accessPackageSuggestions/:accessPackageSuggestion-id
  • PATCHUpdate access package suggestion/identityGovernance/entitlementManagement/accessPackageSuggestions/:accessPackageSuggestion-id
  • GETGet assignment policy/identityGovernance/entitlementManagement/assignmentPolicies/:accessPackageAssignmentPolicy-idIn Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignmentPolicy object.
  • PUTReplace assignment policy/identityGovernance/entitlementManagement/assignmentPolicies/:accessPackageAssignmentPolicy-idUpdate an existing accessPackageAssignmentPolicy object to change one or more of its properties, such as the display name or description.

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Base URL
https://graph.microsoft.com/v1.0
Authentication
OAuth 2.0 (authorization code, client credentials flows)
Operations
400 operations on 209 pathsGET 193POST 81DELETE 63PATCH 60PUT 3
Main resources
Identity governance: entitlement management 160Identity governance: lifecycle workflows 55Identity governance: privileged access 55Identity governance: access reviews 40Identity governance: catalogs 27Identity governance: terms of use 20Identity governance: app consent 11Agreements: file 8Agreements: files 7Agreement acceptances 5
Description format
OpenAPI 3.0.4, API version v1.0

How to test the Microsoft Graph: Identity governance in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Microsoft Graph: Identity governance collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code, client credentials flows). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List agreements” (GET /agreements), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Microsoft Graph: Identity governance?

Entitlement management (access packages and assignments), access reviews, privileged identity management, lifecycle workflows and terms of use. This listing… It is listed under Identity & security and has 400 endpoints.

Who publishes the Microsoft Graph: Identity governance?

It is listed from Microsoft's public API description (an OpenAPI document), not published by Microsoft on Swastik Codes. Anyone who controls microsoft.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Microsoft Graph: Identity governance?

Requests go to https://graph.microsoft.com/v1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Microsoft Graph: Identity governance?

With OAuth 2.0 (authorization code, client credentials flows).

How many endpoints does the Microsoft Graph: Identity governance have?

400 operations on 209 paths (193 GET, 81 POST, 63 DELETE, 60 PATCH, 3 PUT). The largest groups are Identity governance: entitlement management, Identity governance: lifecycle workflows, Identity governance: privileged access, Identity governance: access reviews.

Is forking the Microsoft Graph: Identity governance free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.