EntitlementManagement.ReadWrite.All
Allows the app to request access to and management of access packages and related entitlement management resources on behalf of the signed-in user.
Caution
Permissions that allow granting authorization, such as EntitlementManagement.ReadWrite.All, allow an application to grant additional privileges to itself, other applications, or any user. Use caution when granting any of these permissions.
With the EntitlementManagement.ReadWrite.All permission, an application can manage authorizations for all resources that have been onboarded by resource owners to entitlement management catalogs. This includes Microsoft Entra role assignments, app role assignments and API permissions (including Microsoft Graph) of Microsoft Entra integrated apps, Azure resource roles, SharePoint site roles, group memberships, and more. For details, see Add a resource to a catalog.
Merill's Note
For an app to access data in Microsoft Graph, the user or administrator must grant it the permissions it needs. This article lists all the Microsoft Graph APIs and your tenant data that can be accessed by the application (vendor/developer) if you consent to the
EntitlementManagement.ReadWrite.Allpermission.If you need to create an audit report of the permissions granted to all the apps in your tenant, you can run the
Export-MsIdAppConsentGrantReportcommand. See How To: Run a quick OAuth app audit of your tenant
| Category | Application | Delegated |
|---|---|---|
| Identifier | 9acd699f-1e81-4958-b001-93b1d2506e19 | ae7a573d-81d7-432b-ad44-4ed5c9d89038 |
| DisplayText | Read and write all entitlement management resources | Read and write entitlement management resources |
| Description | Allows the app to read and write access packages and related entitlement management resources without a signed-in user. | Allows the app to request access to and management of access packages and related entitlement management resources on behalf of the signed-in user. |
| AdminConsentRequired | Yes | Yes |
Graph Methods
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
→ API supports delegated access (access on behalf of a user)
→ API supports app-only access (access without a user)
| Methods | |
|---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
→ Command supports delegated access (access on behalf of a user)
→ Command supports app-only access (access without a user)
| Commands | |
|---|---|
Resources
Granting this permission allows the calling application to access (and/or update) the following information in your tenant.
- accessDriftDetail
- accessDriftReport
- accessDriftReportRequest
- accessDriftSummary
- accessPackage
- accessPackageAssignment
- accesspackageassignment-accesspackageassignmentfilterbycurrentuseroptions
- accessPackageAssignmentApprovalSettings
- accessPackageAssignmentPolicy
- accessPackageAssignmentRequest
- accessPackageAssignmentRequestCallbackData
- accesspackageassignmentrequestfilterbycurrentuseroptions
- accessPackageAssignmentRequestorSettings
- accessPackageAssignmentRequestRequirements
- accessPackageAssignmentRequestWorkflowExtension
- accessPackageAssignmentResourceRole
- accessPackageAssignmentReviewSettings
- accessPackageAssignmentWorkflowExtension
- accessPackageCatalog
- notificationSettings
- accessPackageQuestion
- accessPackageResource
- accessPackageResourceEnvironment
- accessPackageResourceRequest
- accessPackageResourceRole
- accessPackageResourceRoleScope
- accessPackageResourceScope
- accessPackageSubject
- accessPackageSuggestion
- approval
- approvalSettings
- approvalStage
- approvalStep
- assignmentReviewSettings
- availableAccessPackage
- azureActiveDirectoryTenant
- connectedOrganization
- connectionInfo
- customaccesspackageworkflowextension
- customCalloutExtension
- customDataProvidedResource
- customDataProvidedResourceAccessReviewUploadSession
- customDataProvidedResourceFile
- accessReviewContextData
- data
- customDataProvidedResourceUploadSession
- customDataProvidedResourceUploadSessionRequest
- customExtensionAuthenticationConfiguration
- customExtensionCallbackConfiguration
- customExtensionEndpointConfiguration
- directoryObject
- domainIdentitySource
- endUserSettings
- entitlementmanagement-overview
- entitlementManagementSettings
- expirationPattern
- externalDomainFederation
- externalOriginResourceConnector
- externalSponsors
- group
- identitySource
- internalSponsors
- privilegedAccessGroupAssignmentScheduleRequest
- privilegedidentitymanagement-for-groups-api-overview
- privilegedidentitymanagementv3-overview
- requestorSettings
- servicePrincipal
- site
- subjectSet
- unifiedRoleAssignment
- unifiedRoleAssignmentScheduleRequest
- unifiedRoleDefinition
- user
Graph reference: accessDriftDetail
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time when the drift record was created. |
| driftSource | accessDriftSource | The comparison system that detected the drift. The possible values are: entra, externalApplication, unknownFutureValue. |
| driftType | accessDriftType | The classification of the drift. The possible values are: unauthorized, missing, inSync, unknownFutureValue. |
| id | String | The unique identifier for the drift detail. Inherited from entity. |
| resource | driftResourceInfo | The governed resource associated with this drift record. |
Graph reference: accessDriftReport
| Property | Type | Description |
|---|---|---|
| downloadUri | String | The time-limited SAS URI for downloading the report file. This property is populated only in the response of the generateDownloadUri action. |
| expiresAt | DateTimeOffset | The date and time when the download URI expires. This property is populated only in the response of the generateDownloadUri action. |
| id | String | A randomly generated identifier for this report instance. Inherited from entity. |
| resourceType | accessDriftReportResourceType | The resource type of the report. The possible values are: application, group, unknownFutureValue. |
Graph reference: accessDriftReportRequest
| Property | Type | Description |
|---|---|---|
| catalogId | String | Reserved for future use. This property is currently ignored, and the report includes data from all catalogs. |
| reportFormat | String | The file format of the report. The supported values are csv and parquet. For the generateDownloadUri action, specify parquet. |
| resourceIds | String collection | Reserved for future use. This property is currently ignored, and the report includes all resources of the specified resource type. |
| resourceType | accessDriftReportResourceType | The type of resource for the report. The possible values are: application, group, unknownFutureValue. |
Graph reference: accessDriftSummary
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time when the drift snapshot was created. |
| driftCounts | driftCounts | The aggregate counts of unauthorized and missing assignments for this resource. |
| driftSource | accessDriftSource | The comparison system that detected the drift. The possible values are: entra, externalApplication, unknownFutureValue. |
| id | String | The unique identifier for the access drift summary. Inherited from entity. |
| resource | driftResourceInfo | The governed resource associated with this drift summary. |
Graph reference: accessPackage
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| description | String | The description of the access package. |
| displayName | String | Required. The display name of the access package. Supports $filter (eq, contains). |
| id | String | Read-only. |
| isHidden | Boolean | Indicates whether the access package is hidden from the requestor. |
| modifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
Graph reference: accessPackageAssignment
| Property | Type | Description |
|---|---|---|
| customExtensionCalloutInstances | customExtensionCalloutInstance collection | Information about all the custom extension calls that were made during the access package assignment workflow. |
| expiredDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| id | String | Read-only. |
| schedule | entitlementManagementSchedule | When the access assignment is to be in place. Read-only. |
| state | accessPackageAssignmentState | The state of the access package assignment. The possible values are: delivering, partiallyDelivered, delivered, expired, deliveryFailed, unknownFutureValue. Read-only. Supports $filter (eq). |
| status | String | More information about the assignment lifecycle. Possible values include Delivering, Delivered, AutoAssignmentInGracePeriod, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only. |
Graph reference: accesspackageassignment-accesspackageassignmentfilterbycurrentuseroptions
Graph reference: accessPackageAssignmentApprovalSettings
| Property | Type | Description |
|---|---|---|
| isApprovalRequiredForAdd | Boolean | If false, then approval isn't required for new requests in this policy. |
| isApprovalRequiredForUpdate | Boolean | If false, then approval isn't required for updates to requests in this policy. |
| isRequestorJustificationRequired | Boolean | If false, then requestor justification isn't required for updates to requests in this policy. |
| stages | accessPackageApprovalStage collection | If approval is required, the one, two or three elements of this collection define each of the stages of approval. An empty array is present if no approval is required. |
Graph reference: accessPackageAssignmentPolicy
| Property | Type | Description |
|---|---|---|
| accessPackageNotificationSettings | accessPackageNotificationSettings | Represents the settings for email notifications for requests to an access package. |
| allowedTargetScope | allowedTargetScope | Principals that can be assigned the access package through this policy. The possible values are: notSpecified, specificDirectoryUsers, specificConnectedOrganizationUsers, specificDirectoryServicePrincipals, allMemberUsers, allDirectoryUsers, allDirectoryServicePrincipals, allConfiguredConnectedOrganizationUsers, allExternalUsers, allDirectoryAgentIdentities, unknownFutureValue. |
| automaticRequestSettings | accessPackageAutomaticRequestSettings | This property is only present for an auto assignment policy; if absent, this is a request-based policy. |
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| description | String | The description of the policy. |
| displayName | String | The display name of the policy. |
| expiration | expirationPattern | The expiration date for assignments created in this policy. |
| id | String | Read-only. |
| modifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| requestApprovalSettings | accessPackageAssignmentApprovalSettings | Specifies the settings for approval of requests for an access package assignment through this policy. For example, if approval is required for new requests. |
| requestorSettings | accessPackageAssignmentRequestorSettings | Provides additional settings to select who can create a request for an access package assignment through this policy, and what they can include in their request. |
| reviewSettings | accessPackageAssignmentReviewSettings | Settings for access reviews of assignments through this policy. |
| specificAllowedTargets | subjectSet collection | The principals that can be assigned access from an access package through this policy. |
Graph reference: accessPackageAssignmentRequest
| Property | Type | Description |
|---|---|---|
| answers | accessPackageAnswer collection | Answers provided by the requestor to accessPackageQuestions asked of them at the time of request. |
| completedDateTime | DateTimeOffset | The date of the end of processing, either successful or failure, of a request. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| customExtensionCalloutInstances | customExtensionCalloutInstance collection | Information about all the custom extension calls that were made during the access package assignment workflow. |
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Supports $filter. |
| id | String | Read-only. |
| justification | String | The requestor's supplied justification. |
| requestType | accessPackageRequestType | The type of the request. The possible values are: notSpecified, userAdd, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. Use the Prefer: include-unknown-enum-members request header to get the following values in this evolvable enum: approverRemove. Requests from the user have a requestType of userAdd, userUpdate, or userRemove. This property can't be changed once set. |
| schedule | entitlementManagementSchedule | The range of dates that access is to be assigned to the requestor. This property can't be changed once set, but a new schedule for an assignment can be included in another userUpdate or adminUpdate assignment request. |
| state | accessPackageRequestState | The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq). |
| status | String | More information on the request processing status. Read-only. |
Graph reference: accessPackageAssignmentRequestCallbackData
| Property | Type | Description |
|---|---|---|
| customExtensionStageInstanceId | String | Unique identifier of the callout to the custom extension. |
| customExtensionStageInstanceDetail | String | Details for the callback. |
| stage | accessPackageCustomExtensionStage | Indicates the stage at which the custom callout extension is executed. The possible values are: assignmentRequestCreated, assignmentRequestApproved, assignmentRequestGranted, assignmentRequestRemoved, assignmentFourteenDaysBeforeExpiration, assignmentOneDayBeforeExpiration, unknownFutureValue. |
| state | accessPackageRequestState | Allow the extension to be able to deny or cancel the request submitted by the requestor. The supported values are Denied and Canceled. This property can only be set for an assignmentRequestCreated stage. |
Graph reference: accesspackageassignmentrequestfilterbycurrentuseroptions
Graph reference: accessPackageAssignmentRequestorSettings
| Property | Type | Description |
|---|---|---|
| allowCustomAssignmentSchedule | Boolean | False indicates that the requestor isn't permitted to include a schedule in their request. |
| enableOnBehalfRequestorsToAddAccess | Boolean | True allows on-behalf-of requestors to create a request to add access for another principal. |
| enableOnBehalfRequestorsToRemoveAccess | Boolean | True allows on-behalf-of requestors to create a request to remove access for another principal. |
| enableOnBehalfRequestorsToUpdateAccess | Boolean | True allows on-behalf-of requestors to create a request to update access for another principal. |
| enableTargetsToSelfAddAccess | Boolean | True allows requestors to create a request to add access for themselves. |
| enableTargetsToSelfRemoveAccess | Boolean | True allows requestors to create a request to remove their access. |
| enableTargetsToSelfUpdateAccess | Boolean | True allows requestors to create a request to update their access. |
| onBehalfRequestors | subjectSet collection | The principals who can request on-behalf-of others. |
Graph reference: accessPackageAssignmentRequestRequirements
| Property | Type | Description |
|---|---|---|
| allowCustomAssignmentSchedule | Boolean | Indicates whether the requestor is allowed to set a custom schedule. |
| isApprovalRequiredForAdd | Boolean | Indicates whether a request to add must be approved by an approver. |
| isApprovalRequiredForUpdate | Boolean | Indicates whether a request to update must be approved by an approver. |
| isRequestorJustificationRequired | Boolean | Indicates whether requestors must justify requesting access to an access package. |
| policyDescription | String | The description of the policy that the user is trying to request access using. |
| policyDisplayName | String | The display name of the policy that the user is trying to request access using. |
| policyId | String | The identifier of the policy that these requirements are associated with. This identifier can be used when creating a new assignment request. |
| questions | accessPackageQuestion collection | Questions that are configured on the policy. The questions can be required or optional; callers can determine whether a question is required or optional based on the isRequired property on accessPackageQuestion. |
| schedule | entitlementManagementSchedule | Schedule restrictions enforced, if any. |
Graph reference: accessPackageAssignmentRequestWorkflowExtension
| Property | Type | Description |
|---|---|---|
| authenticationConfiguration | customExtensionAuthenticationConfiguration | Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. Inherited from customCalloutExtension. |
| callbackConfiguration | customExtensionCallbackConfiguration | The callback configuration for a custom extension. |
| clientConfiguration | customExtensionClientConfiguration | HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension. |
| createdBy | String | The userPrincipalName of the user or identity of the subject that created this resource. Read-only. |
| createdDateTime | DateTimeOffset | When the object was created. |
| description | String | Description for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. |
| displayName | String | Display name for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. |
| endpointConfiguration | customExtensionEndpointConfiguration | The type and details for configuring the endpoint to call the logic app's workflow. Inherited from customCalloutExtension. |
| id | String | Read-only. |
| lastModifiedBy | String | The userPrincipalName of the identity that last modified the object. |
| lastModifiedDateTime | DateTimeOffset | When the object was last modified. |
Graph reference: accessPackageAssignmentResourceRole
| Property | Type | Description |
|---|---|---|
| id | String | Read-only. |
| originId | String | A unique identifier relative to the origin system, corresponding to the originId property of the accessPackageResourceRole. |
| originSystem | String | The system where the role assignment is to be created or has been created for an access package assignment, such as SharePointOnline, AadGroup, or AadApplication, corresponding to the originSystem property of the accessPackageResourceRole. |
| status | String | The value is PendingFulfillment before the access package assignment is delivered to the origin system, and Fulfilled after the access package assignment is delivered to the origin system. |
Graph reference: accessPackageAssignmentReviewSettings
| Property | Type | Description |
|---|---|---|
| expirationBehavior | accessReviewExpirationBehavior | The default decision to apply if the access is not reviewed. The possible values are: keepAccess, removeAccess, acceptAccessRecommendation, unknownFutureValue. |
| fallbackReviewers | subjectSet collection | This collection specifies the users who will be the fallback reviewers when the primary reviewers don't respond. |
| isEnabled | Boolean | If true, access reviews are required for assignments through this policy. |
| isRecommendationEnabled | Boolean | Specifies whether to display recommendations to the reviewer. The default value is true. |
| isReviewerJustificationRequired | Boolean | Specifies whether the reviewer must provide justification for the approval. The default value is true. |
| isSelfReview | Boolean | Specifies whether the principals can review their own assignments. |
| primaryReviewers | subjectSet collection | This collection specifies the users or group of users who will review the access package assignments. |
| schedule | entitlementManagementSchedule | When the first review should start and how often it should recur. |
Graph reference: accessPackageAssignmentWorkflowExtension
| Property | Type | Description |
|---|---|---|
| authenticationConfiguration | customExtensionAuthenticationConfiguration | Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. Inherited from customCalloutExtension. |
| callbackConfiguration | customExtensionCallbackConfiguration | The callback configuration for a custom extension. |
| clientConfiguration | customExtensionClientConfiguration | HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app. The settings define how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension. |
| createdBy | String | The userPrincipalName of the user or identity of the subject that created this resource. Read-only. |
| createdDateTime | DateTimeOffset | When the entity was created. |
| description | String | Description for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. |
| displayName | String | Display name for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. |
| endpointConfiguration | customExtensionEndpointConfiguration | The type and details for configuring the endpoint to call the logic app's workflow. Inherited from customCalloutExtension. |
| id | String | Read-only. |
| lastModifiedBy | String | The userPrincipalName of the identity that last modified the entity. |
| lastModifiedDateTime | DateTimeOffset | When the entity was last modified. |
Graph reference: accessPackageCatalog
| Property | Type | Description |
|---|---|---|
| catalogType | accessPackageCatalogType | Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, serviceDefault, serviceManaged, unknownFutureValue. |
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| description | String | The description of the access package catalog. |
| displayName | String | The display name of the access package catalog. |
| id | String | Read-only. |
| isExternallyVisible | Boolean | Whether the access packages in this catalog can be requested by users outside of the tenant. |
| modifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| state | accessPackageCatalogState | Has the value published if the access packages are available for management. The possible values are: unpublished, published, unknownFutureValue. |
Graph reference: notificationSettings
| Property | Type | Description |
|---|---|---|
| isAssignmentNotificationDisabled | Boolean | Indicates if notification emails for an access package are disabled within an access package assignment policy. |
Graph reference: accessPackageQuestion
| Property | Type | Description |
|---|---|---|
| id | String | ID of the question. |
| isAnswerEditable | Boolean | Specifies whether the requestor is allowed to edit answers to questions for an assignment by posting an update to accessPackageAssignmentRequest. |
| isRequired | Boolean | Whether the requestor is required to supply an answer or not. |
| localizations | accessPackageLocalizedText collection | The text of the question represented in a format for a specific locale. |
| text | String | The text of the question to show to the requestor. |
| sequence | Int32 | Relative position of this question when displaying a list of questions to the requestor. |
Graph reference: accessPackageResource
| Property | Type | Description |
|---|---|---|
| attributes | accessPackageResourceAttribute collection | Contains information about the attributes to be collected from the requestor and sent to the resource application. |
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| description | String | A description for the resource. |
| displayName | String | The display name of the resource, such as the application name, group name or site name. |
| id | String | Read-only. |
| modifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| originId | String | The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group. |
| originSystem | String | The type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup. |
Graph reference: accessPackageResourceEnvironment
| Property | Type | Description |
|---|---|---|
| connectionInfo | connectionInfo | Connection information of an environment used to connect to a resource. |
| createdDateTime | DateTimeOffset | The date and time that this object was created. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| description | String | The description of this object. |
| displayName | String | The display name of this object. |
| id | String | The system-assigned unique identifier of the object. |
| isDefaultEnvironment | Boolean | Determines whether this is default environment or not. It is set to true for all static origin systems, such as Microsoft Entra groups and Microsoft Entra Applications. |
| modifiedDateTime | DateTimeOffset | The date and time that this object was last modified. The DateTimeOffset type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| originId | String | The unique identifier of this environment in the origin system. |
| originSystem | String | The type of the resource in the origin system, that is, SharePointOnline. Requires $filter (eq). |
Graph reference: accessPackageResourceRequest
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| id | String | Read-only. |
| requestType | accessPackageRequestType | The type of the request. Use adminAdd to add a resource, if the caller is an administrator or resource owner, adminUpdate to update a resource, or adminRemove to remove a resource. |
| state | accessPackageRequestState | The outcome of whether the service was able to add the resource to the catalog. The value is delivered if the resource was added or removed, and deliveryFailed if it couldn't be added or removed. Read-only. |
Graph reference: accessPackageResourceRole
| Property | Type | Description |
|---|---|---|
| description | String | A description for the resource role. |
| displayName | String | The display name of the resource role such as the role defined by the application. |
| id | String | Read-only. |
| originId | String | The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site. |
| originSystem | String | The type of the resource in the origin system, such as SharePointOnline, AadApplication, AzureResources, or AadGroup. |
| type | roleType | The role type for the Azure resource role. The possible values are: active, eligible, application, delegated, unknownFutureValue. The values active and eligible are only supported where **o |
Graph reference: accessPackageResourceRoleScope
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z |
| id | String | Read-only. |
Graph reference: accessPackageResourceScope
| Property | Type | Description |
|---|---|---|
| description | String | The description of the scope. |
| displayName | String | The display name of the scope. |
| id | String | Read-only. |
| isRootScope | Boolean | True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource. |
| originId | String | The unique identifier of the resource in the origin system. If a Microsoft Entra group, originId is the identifier of the group. Supports $filter (eq). |
| originSystem | String | The type of the resource in the origin system, such as SharePointOnline, AadApplication, AadGroup, AzureResources, or CustomDataProvidedResource. Supports $filter (eq). |
Graph reference: accessPackageSubject
| Property | Type | Description |
|---|---|---|
| displayName | String | The display name of the subject. |
| String | The email address of the subject. | |
| id | String | This property shouldn't be used as a dependency, as it could change without notice. Instead, use the objectId property. |
| objectId | String | The object identifier of the subject. null if the subject isn't yet a user in the tenant. |
| onPremisesSecurityIdentifier | String | A string representation of the principal's security identifier, if known, or null if the subject doesn't have a security identifier. |
| principalName | String | The principal name, if known, of the subject. |
| subjectLifecycle | accessPackageSubjectLifecycle | The lifecycle of the subject user, if a guest. The possible values are: notDefined, notGoverned, governed, unknownFutureValue. |
| subjectType | accessPackageSubjectType | The resource type of the subject. The possible values are: notSpecified, user, servicePrincipal, unknownFutureValue. |
Graph reference: accessPackageSuggestion
| Property | Type | Description |
|---|---|---|
| id | String | The identifier of the suggested access package. Read-only. |
| reasons | Collection(accessPackageSuggestionReason) | A collection of reasons why this access package is being suggested to the user. |
Graph reference: approval
| Property | Type | Description |
|---|---|---|
| id | String | Identifier of the approval decision. |
Graph reference: approvalSettings
| Property | Type | Description |
|---|---|---|
| approvalMode | String | One of SingleStage, Serial, Parallel, NoApproval (default). NoApproval is used when isApprovalRequired is false. |
| approvalStages | unifiedApprovalStage collection | If approval is required, the one or two elements of this collection define each of the stages of approval. An empty array if no approval is required. |
| isApprovalRequired | Boolean | Indicates whether approval is required for requests in this policy. |
| isApprovalRequiredForExtension | Boolean | Indicates whether approval is required for a user to extend their assignment. |
| isRequestorJustificationRequired | Boolean | Indicates whether the requestor is required to supply a justification in their request. |
Graph reference: approvalStage
| Property | Type | Description |
|---|---|---|
| assignedToMe | Boolean | Indicates whether the stage is assigned to the calling user to review. Read-only. |
| displayName | String | The label provided by the policy creator to identify an approval stage. Read-only. |
| id | String | The identifier of the stage associated with an approval object. Read-only. |
| justification | String | The justification associated with the approval stage decision. |
| reviewResult | String | The result of this approval record. Possible values include: NotReviewed, Approved, Denied. |
| reviewedBy | identity | The identifier of the reviewer. 00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn't reviewed. Read-only. |
| reviewedDateTime | DateTimeOffset | The date and time when a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| status | String | The stage status. Possible values: InProgress, Initializing, Completed, Expired. Read-only. |
Graph reference: approvalStep
| Property | Type | Description |
|---|---|---|
| assignedToMe | Boolean | Indicates whether the step is assigned to the calling user to review. Read-only. |
| displayName | String | The label provided by the policy creator to identify an approval step. Read-only. |
| id | String | The identifier of the step associated with an approval object. Read-only. |
| justification | String | The justification associated with the approval step decision. |
| reviewResult | String | The result of this approval record. Possible values include: NotReviewed, Approved, Denied. |
| reviewedBy | userIdentity collection | The identifier of the reviewer. 00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn't reviewed. Read-only. |
| reviewedDateTime | DateTimeOffset | The date and time when a decision was recorded. The date and time information uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| status | String | The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only. |
Graph reference: assignmentReviewSettings
| Property | Type | Description |
|---|---|---|
| accessReviewTimeoutBehavior | accessReviewTimeoutBehavior | The default decision to apply if the request isn't reviewed within the period specified in durationInDays. The possible values are: acceptAccessRecommendation, keepAccess, removeAccess, and unknownFutureValue. |
| durationInDays | Int32 | The number of days within which reviewers should provide input. |
| isAccessRecommendationEnabled | Boolean | Specifies whether to display recommendations to the reviewer. The default value is true |
| isApprovalJustificationRequired | Boolean | Specifies whether the reviewer must provide justification for the approval. The default value is true. |
| isEnabled | Boolean | If true, access reviews are required for assignments from this policy. |
| recurrenceType | String | The interval for recurrence, such as monthly or quarterly. |
| reviewerType | String | Who should be asked to do the review, either Self, Reviewers or Manager. |
| reviewers | userSet collection | If the reviewerType is Reviewers, this collection specifies the users who will be reviewers, either by ID or as members of a group, using a collection of singleUser and groupMembers. |
| startDateTime | DateTimeOffset | When the first review should start. |
Graph reference: availableAccessPackage
| Property | Type | Description |
|---|---|---|
| description | String | The description of the access package. |
| displayName | String | The display name of the access package. |
| id | String | Identifier of the access package. Read-only. |
Graph reference: azureActiveDirectoryTenant
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the Microsoft Entra tenant. Read-only. |
| tenantId | String | The ID of the Microsoft Entra tenant. Read-only. |
Graph reference: connectedOrganization
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| description | String | The description of the connected organization. |
| displayName | String | The display name of the connected organization. Supports $filter (eq). |
| id | String | Read-only. |
| identitySources | identitySource collection | The identity sources in this connected organization, one of azureActiveDirectoryTenant, crossCloudAzureActiveDirectoryTenant, domainIdentitySource, externalDomainFederation, or socialIdentitySource. Nullable. |
| modifiedDateTime | DateTimeOffset | *The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| state | connectedOrganizationState | The state of a connected organization defines whether assignment policies with requestor scope type AllConfiguredConnectedOrganizationSubjects are applicable or not. The possible values are: configured, proposed, unknownFutureValue. |
Graph reference: connectionInfo
| Property | Type | Description |
|---|---|---|
| url | String | The endpoint that is used by Entitlement Management to communicate with the access package resource. |
Graph reference: customaccesspackageworkflowextension
| Property | Type | Description |
|---|---|---|
| authenticationConfiguration | customExtensionAuthenticationConfiguration | Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. Inherited from customCalloutExtension. |
| clientConfiguration | customExtensionClientConfiguration | HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. Inherited from customCalloutExtension. |
| createdDateTime | DateTimeOffset | Represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
| description | String | Description for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. Read-only. |
| displayName | String | Display name for the customAccessPackageWorkflowExtension object. Inherited from customCalloutExtension. Read-only. Supports $filter (contains). |
| endpointConfiguration | customExtensionEndpointConfiguration | The type and details for configuring the endpoint to call the logic app's workflow. Inherited from customCalloutExtension. |
| id | String | Identifier for the customAccessPackageWorkflowExtension object. Inherited from entity. |
| lastModifiedDateTime | DateTimeOffset | Represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. |
Graph reference: customCalloutExtension
| Property | Type | Description |
|---|---|---|
| authenticationConfiguration | customExtensionAuthenticationConfiguration | Configuration for securing the API call to the logic app. For example, using OAuth client credentials flow. |
| clientConfiguration | customExtensionClientConfiguration | HTTP connection settings that define how long Microsoft Entra ID can wait for a connection to a logic app, how many times you can retry a timed-out connection and the exception scenarios when retries are allowed. |
| description | String | Description for the customCalloutExtension object. |
| displayName | String | Display name for the customCalloutExtension object. |
| endpointConfiguration | customExtensionEndpointConfiguration | The type and details for configuring the endpoint to call the logic app's workflow. |
| id | String | Identifier for the customCalloutExtension object. Inherited from entity. |
Graph reference: customDataProvidedResource
| Property | Type | Description |
|---|---|---|
| attributes | accessPackageResourceAttribute collection | Contains information about the attributes to be collected from the requestor and sent to the resource application. Inherited from accessPackageResource. |
| createdDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from accessPackageResource. |
| description | String | A description for the resource. Inherited from accessPackageResource. |
| displayName | String | The display name of the resource, such as the application name, group name, or site name. Inherited from accessPackageResource. |
| id | String | Read-only. Inherited from accessPackageResource. |
| modifiedDateTime | DateTimeOffset | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Inherited from accessPackageResource. |
| notificationEndpointConfiguration | customExtensionEndpointConfiguration | The endpoint configuration of the logic app that is triggered when the access review for this resource goes into an initializing state. |
| originId | String | The unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group. Inherited from accessPackageResource. |
| originSystem | String | The type of the resource in the origin system. For a customDataProvidedResource, the value is always CustomDataProvidedResource. Inherited from accessPackageResource. |
Graph reference: customDataProvidedResourceAccessReviewUploadSession
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | DateTime when the upload session was created. Read-only. Supports $orderby. Inherited from customDataProvidedResourceUploadSession. |
| data | microsoft.graph.customDataProvidedResourcePayloads.data | An object containing the context for which this data is being uploaded. For access review upload sessions, this is of type microsoft.graph.customDataProvidedResourcePayloads.accessReviewContextData. Inherited from customDataProvidedResourceUploadSession. |
| id | String | Unique identifier of the upload session. Read-only. Inherited from customDataProvidedResourceUploadSession. |
| isUploadDone | Boolean | Indicates if all the necessary files have been uploaded to this session. Inherited from customDataProvidedResourceUploadSession. |
| referenceId | String | The ID of the context for which data is being uploaded, for example, the access review instance ID. Supports $filter (eq). Inherited from customDataProvidedResourceUploadSession. |
| stats | customDataProvidedResourceUploadStats | Metadata about the files uploaded in this upload session thus far. Inherited from customDataProvidedResourceUploadSession. |
| status | customDataProvidedResourceUploadStatus | Status of the upload session. The possible values are: active, complete, expired, unknownFutureValue. Supports $filter (eq). Inherited from customDataProvidedResourceUploadSession. |
Graph reference: customDataProvidedResourceFile
| Property | Type | Description |
|---|---|---|
| id | String | Unique identifier for the file. Read-only. |
| name | String | Name of the uploaded file, including the file extension. Required. Supports $filter (eq, ne) and $orderby. |
| size | Int64 | Size of the file in bytes. Read-only. Supports $filter (eq, ne, gt, ge, lt, le) and $orderby. |
| uploadedDateTime | DateTimeOffset | Timestamp when the file was uploaded. Read-only. Supports $filter (eq, ne, gt, ge, lt, le) and $orderby. |
Graph reference: accessReviewContextData
| Property | Type | Description |
|---|---|---|
| reviewDefinitionId | String | The unique identifier of the access review definition that this data is associated with. Inherited from microsoft.graph.customDataProvidedResourcePayloads.accessReviewContextDataBase. |
| reviewInstanceId | String | The unique identifier of the access review instance that this data is associated with. Inherited from microsoft.graph.customDataProvidedResourcePayloads.accessReviewContextDataBase. |
Graph reference: data
Graph reference: customDataProvidedResourceUploadSession
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | DateTime when the upload session was created. Read-only. Supports $orderby. |
| data | microsoft.graph.customDataProvidedResourcePayloads.data | An object containing the context for which this data is being uploaded. |
| id | String | Unique identifier of the upload session. Read-only. |
| isUploadDone | Boolean | Indicates if all the necessary files have been uploaded to this session. |
| referenceId | String | The ID of the context for which data is being uploaded, for example, the Access Review instance ID. Supports $filter (eq). |
| stats | customDataProvidedResourceUploadStats | Metadata about the files uploaded in this upload session thus far. |
| status | customDataProvidedResourceUploadStatus | Status of the upload session. The possible values are: active, complete, expired, unknownFutureValue. Supports $filter (eq). |
Graph reference: customDataProvidedResourceUploadSessionRequest
| Property | Type | Description |
|---|---|---|
| data | microsoft.graph.customDataProvidedResourcePayloads.data | An object containing the context for which this data is being uploaded. For access review upload sessions, use microsoft.graph.customDataProvidedResourcePayloads.accessReviewContextData. Required. |
Graph reference: customExtensionAuthenticationConfiguration
Graph reference: customExtensionCallbackConfiguration
| Property | Type | Description |
|---|---|---|
| timeoutDuration | Duration | The maximum duration in ISO 8601 format that Microsoft Entra ID will wait for a resume action for the callout it sent to the logic app. The valid range for custom extensions in lifecycle workflows is five minutes to three hours. The valid range for custom extensions in entitlement management is between 5 minutes and 14 days. For example, PT3H refers to three hours, P3D refers to three days, PT10M refers to ten minutes. |
Graph reference: customExtensionEndpointConfiguration
Graph reference: directoryObject
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | Date and time when this object was deleted. Always null when the object hasn't been deleted. |
| id | String | The unique identifier for the object. For example, 12345678-9abc-def0-1234-56789abcde. The value of the **i |
Graph reference: domainIdentitySource
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the identity source, typically also the domain name. Read-only. |
| domainName | String | The domain name. Read-only. |
Graph reference: endUserSettings
| Property | Type | Description |
|---|---|---|
| relatedPeopleInsightLevel | accessPackageSuggestionRelatedPeopleInsightLevel | The level of related people insights to show in access package suggestions. The possible values are: disabled, count, countAndNames, unknownFutureValue. |
| showApproverDetailsToMembers | Boolean | Indicates whether approver details are shown to end users. When true, approver information is visible to members. |
Graph reference: entitlementmanagement-overview
Graph reference: entitlementManagementSettings
| Property | Type | Description |
|---|---|---|
| durationUntilExternalUserDeletedAfterBlocked | Duration | If externalUserLifecycleAction is blockSignInAndDelete, the duration, typically many days, after an external user is blocked from sign in before their account is deleted. |
| externalUserLifecycleAction | accessPackageExternalUserLifecycleAction | Automatic action that the service should take when an external user's last access package assignment is removed. The possible values are: none, blockSignIn, blockSignInAndDelete, unknownFutureValue. |
| id | String | A constant. Read-only. |
Graph reference: expirationPattern
| Property | Type | Description |
|---|---|---|
| duration | Duration | The requestor's desired duration of access represented in ISO 8601 format for durations. For example, PT3H refers to three hours. If specified in a request, endDateTime should not be present and the type property should be set to afterDuration. |
| endDateTime | DateTimeOffset | Timestamp of date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. |
| type | expirationPatternType | The requestor's desired expiration pattern type. The possible values are: notSpecified, noExpiration, afterDateTime, afterDuration. |
Graph reference: externalDomainFederation
| Property | Type | Description |
|---|---|---|
| displayName | String | The name of the identity source, typically also the domain name. Read-only. |
| domainName | String | The domain name. Read-only. |
| issuerUri | String | The issuerURI of the incoming federation. Read-only. |
Graph reference: externalOriginResourceConnector
| Property | Type | Description |
|---|---|---|
| connectionInfo | connectionInfo | The connection information used to communicate with the external resource system. When connectorType is sapIag, the type is externalTokenBasedSapIagConnectionInfo. |
| connectorType | connectorType | The type of connector to SAP being used. The possible values are: sapIag (SAP Cloud Identity Access Governance), unknownFutureValue. |
| createdBy | String | The identifier of the user or application that created the connector. |
| createdDateTime | DateTimeOffset | The date and time when the connector was created. |
| description | String | A description of the connector. |
| displayName | String | The display name of the connector. |
| id | String | The unique identifier of the connector. Inherited from entity. |
| modifiedBy | String | The identifier of the user or application that last modified the connector. |
| modifiedDateTime | DateTimeOffset | The date and time when the connector was last modified. |
Graph reference: externalSponsors
Graph reference: group
| Property | Type | Description |
|---|---|---|
| accessType | groupAccessType | Indicates the type of access to the group. The possible values are: none, private, secret, public, unknownFutureValue. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| allowExternalSenders | Boolean | Indicates if people external to the organization can send messages to the group. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| assignedLabels | assignedLabel collection | The list of sensitivity label pairs (label ID, label name) associated with a Microsoft 365 group or a cloud security group. Requires a Microsoft Entra ID P1 license. Requires $select to retrieve. This property can be specified during group creation or update. However, for cloud security groups, it's immutable once set. This property can be updated only in delegated scenarios where the caller requires both the Microsoft Graph permission and a supported administrator role. To learn more about managing this property for Microsoft 365 vs. cloud security groups, see Key differences from Microsoft 365 group labeling. |
| assignedLicenses | assignedLicense collection | The licenses that are assigned to the group. Requires $select to retrieve. Supports $filter (eq). Read-only. |
| autoSubscribeNewMembers | Boolean | Indicates if new members added to the group are autosubscribed to receive email notifications. You can set this property in a PATCH request for the group; don't set it in the initial POST request that creates the group. Default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| classification | String | Describes a classification for the group (such as low, medium, or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the template definition. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith). |
| createdDateTime | DateTimeOffset | Timestamp of when the group was created. The value can't be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. |
| deletedDateTime | DateTimeOffset | For some Microsoft Entra objects (user, group, application), if the object is deleted, it's first logically deleted, and this property is updated with the date and time when the object was deleted. Otherwise this property is null. If the object is restored, this property is updated to null. Inherited from directoryObject. |
| description | String | An optional description for the group. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. |
| displayName | String | The display name for the group. This property is required when a group is created and can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. |
| expirationDateTime | DateTimeOffset | Timestamp of when the group is set to expire. It's null for security groups, but for Microsoft 365 groups, it represents when the group is set to expire as defined in the groupLifecyclePolicy. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only. |
| groupTypes | String collection | Specifies the group type and its membership. If the collection contains Unified, the group is a Microsoft 365 group; otherwise, it's either a security group or a distribution group. For details, see groups overview.If the collection includes DynamicMembership, the group has dynamic membership; otherwise, membership is static. Returned by default. Supports $filter (eq, not). |
| hasMembersWithLicenseErrors | Boolean | Indicates whether there are members in this group that have license errors from its group-based license assignment. This property is never returned on a GET operation. You can use it as a $filter argument to get groups that have members with license errors (that is, filter for this property being true). See an example. Supports $filter (eq). |
| hideFromAddressLists | Boolean | True if the group isn't displayed in certain parts of the Outlook UI: the Address Book, address lists for selecting message recipients, and the Browse Groups dialog for searching groups; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| hideFromOutlookClients | Boolean | True if the group isn't displayed in Outlook clients, such as Outlook for Windows and Outlook on the web; otherwise, false. The default value is false. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| id | String | The unique identifier for the group. Returned by default. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in). |
| isArchived | Boolean | When a group is associated with a team, this property determines whether the team is in read-only mode. To read this property, use the /group/{groupId}/team endpoint or the Get team API. To update this property, use the archiveTeam and unarchiveTeam APIs. |
| isAssignableToRole | Boolean | Indicates whether this group can be assigned to a Microsoft Entra role. Optional. This property can only be set while creating the group and is immutable. If set to true, the securityEnabled property must also be set to true, visibility must be Hidden, and the group can't be a dynamic group (that is, groupTypes can't contain DynamicMembership). Only callers with at least the Privileged Role Administrator role can set this property. The caller must also be assigned the RoleManagement.ReadWrite.Directory permission to set this property or update the membership of such groups. For more, see Using a group to manage Microsoft Entra role assignments Using this feature requires a Microsoft Entra ID P1 license. Returned by default. Supports $filter (eq, ne, not). |
| isFavorite | Boolean | Indicates whether the user marked the group as favorite. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| isManagementRestricted | Boolean | Indicates whether the group is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a group member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve. |
| isSubscribedByMail | Boolean | Indicates whether the signed-in user is subscribed to receive email conversations. The default value is true. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| licenseProcessingState | String | Indicates the status of the group license assignment to all group members. The default value is false. Read-only. Possible values: QueuedForProcessing, ProcessingInProgress, and ProcessingComplete.Requires $select to retrieve. Read-only. |
| String | The SMTP address for the group, for example, "[email protected]". Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
|
| mailEnabled | Boolean | Specifies whether the group is mail-enabled. Required. Returned by default. Supports $filter (eq, ne, not). |
| mailNickname | String | The mail alias for the group, unique for Microsoft 365 groups in the organization. Maximum length is 64 characters. This property can contain only characters in the ASCII character set 0 - 127 except the following characters: @ () \ [] " ; : <> , SPACE. Required. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| membershipRule | String | The rule that determines members for this group if the group is a dynamic group (groupTypes contains DynamicMembership). For more information about the syntax of the membership rule, see Membership Rules syntax. Returned by default. Supports $filter (eq, ne, not, ge, le, startsWith). |
| membershipRuleProcessingState | String | Indicates whether the dynamic membership processing is on or paused. Possible values are On or Paused. Returned by default. Supports $filter (eq, ne, not, in). |
| onPremisesDomainName | String | Contains the on-premises domain FQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
| onPremisesExtensionAttributes | onPremisesExtensionAttributes | Complex type containing extension attributes 1-15 for the group, synchronized from on-premises Active Directory. Returned only on $select. Supports $filter (eq, ne, not, in). |
| onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Read-only. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesNetBiosName | String | Contains the on-premises netBios name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Read-only. |
| onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Returned by default. Supports $filter (eq, not). |
| onPremisesSamAccountName | String | Contains the on-premises SAM account name synchronized from the on-premises directory. The property is only populated for customers synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith). Read-only. |
| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the group synchronized from on-premises to the cloud. Read-only. Returned by default. Supports $filter (eq including on null values). |
| onPremisesSyncEnabled | Boolean | true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never synced from an on-premises directory (default). Returned by default. Read-only. Supports $filter (eq, ne, not, in, and eq on null values). |
| preferredDataLocation | String | The preferred data location for the Microsoft 365 group. By default, the group inherits the group creator's preferred data location. To set this property, the calling app must be granted the Directory.ReadWrite.All permission and the user be assigned at least one of the following Microsoft Entra roles:
For more information about this property, see OneDrive Online Multi-Geo. Nullable. Returned by default. |
| preferredLanguage | String | The preferred language for a Microsoft 365 group. Should follow ISO 639-1 Code; for example, en-US. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| proxyAddresses | String collection | Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: [email protected]", "smtp: [email protected]"]. The any operator is required to filter expressions on multi-valued properties. Returned by default. Read-only. Not nullable. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| renewedDateTime | DateTimeOffset | Timestamp of when the group was last renewed. This value can't be modified directly and is only updated via the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on January 1, 2014 is 2014-01-01T00:00:00Z. Returned by default. Supports $filter (eq, ne, not, ge, le, in). Read-only. |
| resourceBehaviorOptions | String collection | Specifies the group behaviors that can be set for a Microsoft 365 group during creation. This property can be set only as part of creation (POST). For the list of possible values, see Microsoft 365 group behaviors and provisioning options. |
| resourceProvisioningOptions | String collection | Specifies the group resources that are associated with the Microsoft 365 group. The possible value is Team. For more information, see Microsoft 365 group behaviors and provisioning options. Returned by default. Supports $filter (eq, not, startsWith). |
| securityEnabled | Boolean | Specifies whether the group is a security group. Required. Returned by default. Supports $filter (eq, ne, not, in). |
| securityIdentifier | String | Security identifier of the group, used in Windows scenarios. Read-only. Returned by default. |
| serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a group object. Supports $filter (eq, not, for isResolved and serviceInstance). |
| theme | string | Specifies a Microsoft 365 group's color theme. Possible values are Teal, Purple, Green, Blue, Pink, Orange, or Red. Returned by default. |
| uniqueName | String | The unique identifier that can be assigned to a group and used as an alternate key. Immutable. Read-only. |
| unseenConversationsCount | Int32 | Count of conversations that have had one or more new posts delivered since the signed-in user's last visit to the group. This property is the same as unseenCount. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| unseenCount | Int32 | Count of conversations that have received new posts since the signed-in user last visited the group. This property is the same as unseenConversationsCount. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| unseenMessagesCount | Int32 | Count of new posts that have been delivered to the group's conversations since the signed-in user's last visit to the group. Requires $select to retrieve. Supported only on the Get group API (GET /groups/{ID}). |
| visibility | String | Specifies the group join policy and group content visibility for groups. The possible values are: Private, Public, or HiddenMembership. HiddenMembership can be set only for Microsoft 365 groups when the groups are created. It can't be updated later. Other values of visibility can be updated after group creation.If visibility value isn't specified during group creation on Microsoft Graph, a security group is created as Private by default, and the Microsoft 365 group is Public. Groups assignable to roles are always Private. To learn more, see group visibility options. Returned by default. Nullable. |
Graph reference: identitySource
Graph reference: internalSponsors
Graph reference: privilegedAccessGroupAssignmentScheduleRequest
| Property | Type | Description |
|---|---|---|
| accessId | privilegedAccessGroupRelationships | The identifier of a membership or ownership assignment relationship to the group. Required. The possible values are: owner, member, unknownFutureValue. |
| action | String | Represents the type of operation on the group membership or ownership assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew.
|
| approvalId | String | The identifier of the approval of the request. Inherited from request. |
| completedDateTime | DateTimeOffset | The request completion date time. Inherited from request. |
| createdBy | identitySet | The principal that created this request. Inherited from request. Read-only. Supports $filter (eq, ne, and on null values). |
| createdDateTime | DateTimeOffset | The request creation date time. Inherited from request. Read-only. |
| customData | String | Free text field to define any custom data for the request. Not used. Inherited from request. |
| groupId | String | The identifier of the group representing the scope of the membership or ownership assignment through PIM for Groups. Required. |
| id | String | The unique identifier for the privilegedAccessGroupAssignmentScheduleRequest object. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, ne). |
| isValidationOnly | Boolean | Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request. |
| justification | String | A message provided by users and administrators when they create the privilegedAccessGroupAssignmentScheduleRequest object. |
| principalId | String | The identifier of the principal whose membership or ownership assignment to the group is managed through PIM for Groups. Supports $filter (eq, ne). |
| scheduleInfo | requestSchedule | The period of the group membership or ownership assignment. Recurring schedules are currently unsupported. |
| status | String | The status of the group membership or ownership assignment request. Inherited from request. Read-only. Supports $filter (eq, ne). |
| targetScheduleId | String | The identifier of the schedule that's created from the membership or ownership assignment request. Supports $filter (eq, ne). |
| ticketInfo | ticketInfo | Ticket details linked to the group membership or ownership assignment request including details of the ticket number and ticket system. |
Graph reference: privilegedidentitymanagement-for-groups-api-overview
Graph reference: privilegedidentitymanagementv3-overview
Graph reference: requestorSettings
| Property | Type | Description |
|---|---|---|
| scopeType | String | Who can request. One of NoSubjects, SpecificDirectorySubjects, SpecificConnectedOrganizationSubjects, AllConfiguredConnectedOrganizationSubjects, AllExistingConnectedOrganizationSubjects, AllExistingDirectoryMemberUsers, AllExistingDirectorySubjects or AllExternalSubjects. |
| acceptRequests | Boolean | Indicates whether new requests are accepted on this policy. |
| allowedRequestors | userSet collection | The users who are allowed to request on this policy, which can be singleUser, groupMembers, and connectedOrganizationMembers. |
Graph reference: servicePrincipal
| Property | Type | Description |
|---|---|---|
| accountEnabled | Boolean | true if the service principal account is enabled; otherwise, false. If set to false, then no users are able to sign in to this app, even if they're assigned to it. Supports $filter (eq, ne, not, in). |
| addIns | addIn collection | Defines custom behavior that a consuming service can use to call an app in specific contexts. For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. This lets services like Microsoft 365 call the application in the context of a document the user is working on. |
| alternativeNames | String collection | Used to retrieve service principals by subscription, identify resource group and full resource IDs for managed identities. Supports $filter (eq, not, ge, le, startsWith). |
| appDescription | String | The description exposed by the associated application. |
| appDisplayName | String | The display name exposed by the associated application. Maximum length is 256 characters. |
| appId | String | The unique identifier for the associated application (its appId property). Alternate key. Supports $filter (eq, ne, not, in, startsWith). |
| applicationTemplateId | String | Unique identifier of the applicationTemplate. Supports $filter (eq, not, ne). Read-only. null if the service principal wasn't created from an application template. |
| appOwnerOrganizationId | Guid | Contains the tenant ID where the application is registered. This is applicable only to service principals backed by applications. Supports $filter (eq, ne, NOT, ge, le). |
| appRoleAssignmentRequired | Boolean | Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. The default value is false. Not nullable. Supports $filter (eq, ne, NOT). |
| appRoles | appRole collection | The roles exposed by the application that's linked to this service principal. For more information, see the appRoles property definition on the application entity. Not nullable. App roles and exposed delegated permission scopes (oauth2PermissionScopes) share a default limit of 700 permission definitions per service principal, including definitions inherited from the application and definitions added directly to the service principal. Enabled and disabled definitions both count. This limit counts definitions, not app role assignments. For counting rules, behavior for existing objects above the limit, and design guidance, see App role limits. |
| createdByAppId | String | The appId of the application that created this service principal. Set internally by Microsoft Entra ID. Read-only. |
| customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Requires $select to retrieve. Supports $filter (eq, ne, not, startsWith). Filter value is case sensitive. |
| deletedDateTime | DateTimeOffset | The date and time the service principal was deleted. Read-only. |
| description | String | Free text field to provide an internal end-user facing description of the service principal. End-user portals such MyApps displays the application description in this field. The maximum allowed size is 1,024 characters. Supports $filter (eq, ne, not, ge, le, startsWith) and $search. |
| disabledByMicrosoftStatus | String | Specifies whether Microsoft has disabled the registered application. The possible values are: null (default value), NotDisabled, and DisabledDueToViolationOfServicesAgreement (reasons include suspicious, abusive, or malicious activity, or a violation of the Microsoft Services Agreement). Supports $filter (eq, ne, not). |
| displayName | String | The display name for the service principal. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby. |
| homepage | String | Home page or landing page of the application. |
| id | String | The unique identifier for the service principal. Inherited from directoryObject. Key. Not nullable. Read-only. Supports $filter (eq, ne, not, in). |
| info | informationalUrl | Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. The terms of service and privacy statement are surfaced to users through the user consent experience. For more info, see How to: Add Terms of service and privacy statement for registered Microsoft Entra apps. Supports $filter (eq, ne, not, ge, le, and eq on null values). |
| keyCredentials | keyCredential collection | The collection of key credentials associated with the service principal. Not nullable. Supports $filter (eq, not, ge, le). |
| loginUrl | String | Specifies the URL where the service provider redirects the user to Microsoft Entra ID to authenticate. Microsoft Entra ID uses the URL to launch the application from Microsoft 365 or the Microsoft Entra My Apps. When blank, Microsoft Entra ID performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. The user launches the application from Microsoft 365, the Microsoft Entra My Apps, or the Microsoft Entra SSO URL. |
| logoutUrl | String | Specifies the URL that the Microsoft's authorization service uses to sign out a user using OpenID Connect front-channel, back-channel, or SAML sign out protocols. |
| notes | String | Free text field to capture information about the service principal, typically used for operational purposes. Maximum allowed size is 1,024 characters. |
| notificationEmailAddresses | String collection | Specifies the list of email addresses where Microsoft Entra ID sends a notification when the active certificate is near the expiration date. This is only for the certificates used to sign the SAML token issued for Microsoft Entra Gallery applications. |
| oauth2PermissionScopes | permissionScope collection | The delegated permissions exposed by the application. For more information, see the oauth2PermissionScopes property on the application entity's api property. Not nullable. These scopes and appRoles share a default limit of 700 permission definitions per service principal. Enabled and disabled definitions both count. For counting rules, behavior for existing objects above the limit, and design guidance, see App role limits. |
| passwordCredentials | passwordCredential collection | The collection of password credentials associated with the application. Not nullable. |
| preferredSingleSignOnMode | string | Specifies the single sign-on mode configured for this application. Microsoft Entra ID uses the preferred single sign-on mode to launch the application from Microsoft 365 or the My Apps portal. The supported values are password, saml, notSupported, and oidc. Note: This field might be null for older SAML apps and for OIDC applications where it isn't set automatically. |
| preferredTokenSigningKeyThumbprint | String | This property can be used on SAML applications (apps that have preferredSingleSignOnMode set to saml) to control which certificate is used to sign the SAML responses. For applications that aren't SAML, don't write or otherwise rely on this property. |
| replyUrls | String collection | The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Not nullable. |
| resourceSpecificApplicationPermissions | resourceSpecificPermission collection | The resource-specific application permissions exposed by this application. Currently, resource-specific permissions are only supported for Teams apps accessing to specific chats and teams using Microsoft Graph. Read-only. |
| samlSingleSignOnSettings | samlSingleSignOnSettings | The collection for settings related to saml single sign-on. |
| servicePrincipalNames | String collection | Contains the list of identifiersUris, copied over from the associated application. Additional values can be added to hybrid applications. These values can be used to identify the permissions exposed by this app within Microsoft Entra ID. For example,
The any operator is required for filter expressions on multi-valued properties. Not nullable. Supports $filter (eq, not, ge, le, startsWith). |
| servicePrincipalType | String | Identifies whether the service principal represents an application, a managed identity, or a legacy application. This property is set by Microsoft Entra ID internally. The servicePrincipalType property can be set to three different values:
SocialIdp - For internal use. |
| signInAudience | String | Specifies the Microsoft accounts that are supported for the current application. Read-only. Supported values are:
|
| tags | String collection | Custom strings that can be used to categorize and identify the service principal. Not nullable. The value is the union of strings set here and on the associated application entity's tags property. Supports $filter (eq, not, ge, le, startsWith). |
| tokenEncryptionKeyId | String | Specifies the keyId of a public key from the keyCredentials collection. When configured, Microsoft Entra ID issues tokens for this application encrypted using the key specified by this property. The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user. |
| verifiedPublisher | verifiedPublisher | Specifies the verified publisher of the application that's linked to this service principal. |
Graph reference: site
| Property | Type | Description |
|---|---|---|
| createdDateTime | DateTimeOffset | The date and time the item was created. Read-only. |
| description | string | The descriptive text for the site. |
| displayName | string | The full title for the site. Read-only. |
| eTag | string | ETag for the item. Read-only. |
| id | string | The unique identifier of the item. Read-only. |
| isPersonalSite | bool | Identifies whether the site is personal or not. Read-only. |
| lastModifiedDateTime | DateTimeOffset | The date and time the item was last modified. Read-only. |
| name | string | The name/title of the item. |
| root | root | If present, provides the root site in the site collection. Read-only. |
| sharepointIds | sharepointIds | Returns identifiers useful for SharePoint REST compatibility. Read-only. |
| siteCollection | siteCollection | Provides details about the site's site collection. Available only on the root site. Read-only. |
| webUrl | string (url) | URL that displays the item in the browser. Read-only. |
Graph reference: subjectSet
Graph reference: unifiedRoleAssignment
| Property | Type | Description |
|---|---|---|
| appScopeId | String | Identifier of the app specific scope when the assignment scope is app specific. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by a resource application only. For the entitlement management provider, use this property to specify a catalog. For example, /AccessPackageCatalog/beedadfe-01d5-4025-910b-84abb9369997. Supports $filter (eq, in). For example, /roleManagement/entitlementManagement/roleAssignments?$filter=appScopeId eq '/AccessPackageCatalog/{catalog id}'. |
| directoryScopeId | String | Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications, unlike app scopes that are defined and understood by a resource application only. Supports $filter (eq, in). |
| id | String | The unique identifier for the unifiedRoleAssignment. Key, not nullable, Read-only. |
| principalId | String | Identifier of the principal to which the assignment is granted. Supported principals are users, role-assignable groups, and service principals. Supports $filter (eq, in). |
| roleDefinitionId | String | Identifier of the unifiedRoleDefinition the assignment is for. Read-only. Supports $filter (eq, in). |
Graph reference: unifiedRoleAssignmentScheduleRequest
| Property | Type | Description |
|---|---|---|
| action | String | Represents the type of the operation on the role assignment request. The possible values are: adminAssign, adminUpdate, adminRemove, selfActivate, selfDeactivate, adminExtend, adminRenew, selfExtend, selfRenew, unknownFutureValue.
|
| approvalId | String | The identifier of the approval of the request. Inherited from request. |
| appScopeId | String | Identifier of the app-specific scope when the assignment is scoped to an app. The scope of an assignment determines the set of resources for which the principal has been granted access. App scopes are scopes that are defined and understood by this application only. Use / for tenant-wide app scopes. Use directoryScopeId to limit the scope to particular directory objects, for example, administrative units. Supports $filter (eq, ne, and on null values). |
| completedDateTime | DateTimeOffset | The request completion date time. Inherited from request. |
| createdBy | identitySet | The principal that created this request. Inherited from request. Read-only. Supports $filter (eq, ne, and on null values). |
| createdDateTime | DateTimeOffset | The request creation date time. Inherited from request. Read-only. |
| customData | String | Free text field to define any custom data for the request. Not used. Inherited from request. |
| directoryScopeId | String | Identifier of the directory object representing the scope of the assignment. The scope of an assignment determines the set of resources for which the principal has been granted access. Directory scopes are shared scopes stored in the directory that are understood by multiple applications. Use / for tenant-wide scope. Use appScopeId to limit the scope to an application only. Supports $filter (eq, ne, and on null values). |
| id | String | The unique identifier for the unifiedRoleAssignmentScheduleRequest object. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, ne). |
| isValidationOnly | Boolean | Determines whether the call is a validation or an actual call. Only set this property if you want to check whether an activation is subject to additional rules like MFA before actually submitting the request. |
| justification | String | A message provided by users and administrators when create they create the unifiedRoleAssignmentScheduleRequest object. |
| principalId | String | Identifier of the principal that has been granted the assignment. Can be a user, role-assignable group, or a service principal. Supports $filter (eq, ne). |
| roleDefinitionId | String | Identifier of the unifiedRoleDefinition object that is being assigned to the principal. Supports $filter (eq, ne). |
| scheduleInfo | requestSchedule | The period of the role assignment. Recurring schedules are currently unsupported. |
| status | String | The status of the role assignment request. Inherited from request. Read-only. Supports $filter (eq, ne). |
| targetScheduleId | String | Identifier of the schedule object that's linked to the assignment request. Supports $filter (eq, ne). |
| ticketInfo | ticketInfo | Ticket details linked to the role assignment request including details of the ticket number and ticket system. |
Graph reference: unifiedRoleDefinition
| Property | Type | Description |
|---|---|---|
| description | String | The description for the unifiedRoleDefinition. Read-only when isBuiltIn is true. |
| displayName | String | The display name for the unifiedRoleDefinition. Read-only when isBuiltIn is true. Required. Supports $filter (eq, in). |
| id | String | The unique identifier for the role definition. Key, not nullable, Read-only. Inherited from entity. Supports $filter (eq, in). |
| isBuiltIn | Boolean | Flag indicating whether the role definition is part of the default set included in Microsoft Entra or a custom definition. Read-only. Supports $filter (eq, in). |
| isEnabled | Boolean | Flag indicating whether the role is enabled for assignment. If false the role is not available for assignment. Read-only when isBuiltIn is true. |
| resourceScopes | String collection | List of the scopes or permissions the role definition applies to. Currently only / is supported. Read-only when isBuiltIn is true. DO NOT USE. This will be deprecated soon. Attach scope to role assignment. |
| rolePermissions | unifiedRolePermission collection | List of permissions included in the role. Read-only when isBuiltIn is true. Required. |
| templateId | String | Custom template identifier that can be set when isBuiltIn is false but is read-only when isBuiltIn is true. This identifier is typically used if one needs an identifier to be the same across different directories. |
| version | String | Indicates version of the role definition. Read-only when **i |
Graph reference: user
| Property | Type | Description |
|---|---|---|
| aboutMe | String | A freeform text entry field for the user to describe themselves. Requires $select to retrieve. |
| accountEnabled | Boolean | true if the account is enabled; otherwise, false. This property is required when a user is created. Requires $select to retrieve. Supports $filter (eq, ne, not, and in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it. |
| ageGroup | ageGroup | Sets the age group of the user. Allowed values: null, Minor, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in). |
| assignedLicenses | assignedLicense collection | The licenses that are assigned to the user, including inherited (group-based) licenses. This property doesn't differentiate between directly assigned and inherited licenses. Use the licenseAssignmentStates property to identify the directly assigned and inherited licenses. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, /$count eq 0, /$count ne 0). |
| assignedPlans | assignedPlan collection | The plans that are assigned to the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq and not). |
| birthday | DateTimeOffset | The birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve. |
| businessPhones | String collection | The telephone numbers for the user. NOTE: Although it's a string collection, only one number can be set for this property. Read-only for users synced from the on-premises directory. Returned by default. Supports $filter (eq, not, ge, le, startsWith). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it. |
| city | String | The city where the user is located. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| companyName | String | The name of the company that the user is associated with. This property can be useful for describing the company that a guest comes from. The maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| consentProvidedForMinor | consentProvidedForMinor | Sets whether consent was obtained for minors. Allowed values: null, Granted, Denied, and NotRequired. For more information, see legal age group property definitions. Requires $select to retrieve. Supports $filter (eq, ne, not, and in). |
| country | String | The country or region where the user is located; for example, US or UK. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| createdDateTime | DateTimeOffset | The date and time the user was created, in ISO 8601 format and UTC. The value can't be modified and is automatically populated when the entity is created. Nullable. For on-premises users, the value represents when they were first created in Microsoft Entra ID. Property is null for some users created before June 2018 and on-premises users that were synced to Microsoft Entra ID before June 2018. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in). |
| creationType | String | Indicates whether the user account was created through one of the following methods:
Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, in). |
| customSecurityAttributes | customSecurityAttributeValue | An open complex type that holds the value of a custom security attribute that is assigned to a directory object. Nullable. Requires $select to retrieve. Supports $filter (eq, ne, not, startsWith). The filter value is case-sensitive. |
| deletedDateTime | DateTimeOffset | The date and time the user was deleted. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in). |
| department | String | The name of the department in which the user works. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, and eq on null values). |
| displayName | String | The name displayed in the address book for the user. This value is usually the combination of the user's first name, middle initial, and family name. This property is required when a user is created and it can't be cleared during updates. Maximum length is 256 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values), $orderby, and $search. |
| employeeHireDate | DateTimeOffset | The date and time when the user was hired or will start work in a future hire. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in). |
| employeeLeaveDateTime | DateTimeOffset | The date and time when the user left or will leave the organization. Supports $filter (eq, ne, not , ge, le, in). For more information, see Configure the employeeLeaveDateTime property for a user. |
| employeeId | String | The employee identifier assigned to the user by the organization. The maximum length is 16 characters. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| employeeOrgData | employeeOrgData | Represents organization data (for example, division and costCenter) associated with a user. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in). |
| employeeType | String | Captures enterprise worker type. For example, Employee, Contractor, Consultant, or Vendor. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith). |
| externalUserState | String | For a guest invited to the tenant using the invitation API, this property represents the invited user's invitation status. For invited users, the state can be PendingAcceptance or Accepted, or null for all other users. Requires $select to retrieve. Supports $filter (eq, ne, not , in). |
| externalUserStateChangeDateTime | DateTimeOffset | Shows the timestamp for the latest change to the externalUserState property. Requires $select to retrieve. Supports $filter (eq, ne, not , in). |
| faxNumber | String | The fax number of the user. Requires $select to retrieve. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| givenName | String | The given name (first name) of the user. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| hireDate | DateTimeOffset | The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014, is 2014-01-01T00:00:00Z. Requires $select to retrieve. Note: This property is specific to SharePoint in Microsoft 365. We recommend using the native employeeHireDate property to set and update hire date values using Microsoft Graph APIs. |
| id | String | The unique identifier for the user. Should be treated as an opaque identifier. Inherited from directoryObject. Key. Not nullable. Read-only. Returned by default. Supports $filter (eq, ne, not, in). |
| identities | objectIdentity collection | Represents the identities that can be used to sign in to this user account. Microsoft (also known as a local account), organizations, or social identity providers such as Facebook, Google, and Microsoft can provide identity and tie it to a user account. It might contain multiple items with the same signInType value. Requires $select to retrieve. Supports $filter (eq) with limitations. |
| imAddresses | String collection | The instant message voice-over IP (VOIP) session initiation protocol (SIP) addresses for the user. Read-only. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith). |
| interests | String collection | A list for the user to describe their interests. Requires $select to retrieve. |
| isManagementRestricted | Boolean | true if the user is a member of a restricted management administrative unit. If not set, the default value is null and the default behavior is false. Read-only. To manage a user who is a member of a restricted management administrative unit, the administrator or calling app must be assigned a Microsoft Entra role at the scope of the restricted management administrative unit. Requires $select to retrieve. |
| isResourceAccount | Boolean | Don't use – reserved for future use. |
| jobTitle | String | The user's job title. Maximum length is 128 characters. Returned by default. Supports $filter (eq, ne, not , ge, le, in, startsWith, and eq on null values). |
| lastPasswordChangeDateTime | DateTimeOffset | The time when this Microsoft Entra user last changed their password or when their password was created, whichever date the latest action was performed. The date and time information uses ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Requires $select to retrieve. |
| legalAgeGroupClassification | legalAgeGroupClassification | Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, Undefined, MinorWithOutParentalConsent, MinorWithParentalConsent, MinorNoParentalConsentRequired, NotAdult, and Adult. For more information, see legal age group property definitions. Requires $select to retrieve. |
| licenseAssignmentStates | licenseAssignmentState collection | State of license assignments for this user. Also indicates licenses that are directly assigned or the user inherited through group memberships. Read-only. Requires $select to retrieve. |
| String | The SMTP address for the user, for example, [email protected]. Changes to this property update the user's proxyAddresses collection to include the value as an SMTP address. This property can't contain accent characters. NOTE: We don't recommend updating this property for Azure AD B2C user profiles. Use the otherMails property instead. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith, and eq on null values). |
|
| mailboxSettings | mailboxSettings | Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve. |
| mailNickname | String | The mail alias for the user. This property must be specified when a user is created. Maximum length is 64 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| mobilePhone | String | The primary cellular telephone number for the user. Read-only for users synced from the on-premises directory. Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) and $search. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it. |
| mySite | String | The URL for the user's site. Requires $select to retrieve. |
| officeLocation | String | The office location in the user's place of business. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| onPremisesDistinguishedName | String | Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. |
| onPremisesDomainName | String | Contains the on-premises domainFQDN, also called dnsDomainName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. |
| onPremisesExtensionAttributes | onPremisesExtensionAttributes | Contains extensionAttributes1-15 for the user. These extension attributes are also known as Exchange custom attributes 1-15. Each attribute can store up to 1024 characters. false), these properties can be set during the creation or update of a user object. Requires $select to retrieve. Supports $filter (eq, ne, not, in). |
| onPremisesImmutableId | String | This property is used to associate an on-premises Active Directory user account to their Microsoft Entra user object. This property must be specified when creating a new user account in the Graph if you're using a federated domain for the user's userPrincipalName (UPN) property. NOTE: The $ and _ characters can't be used when specifying this property. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in). This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it. |
| onPremisesLastSyncDateTime | DateTimeOffset | Indicates the last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in). |
| onPremisesProvisioningErrors | onPremisesProvisioningError collection | Errors when using Microsoft synchronization product during provisioning. Requires $select to retrieve. Supports $filter (eq, not, ge, le). |
| onPremisesSamAccountName | String | Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith). |
| onPremisesSecurityIdentifier | String | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. Read-only. Requires $select to retrieve. Supports $filter (eq including on null values). |
| onPremisesSyncEnabled | Boolean | true if this user object is currently being synced from an on-premises Active Directory (AD); otherwise the user isn't being synced and can be managed in Microsoft Entra ID. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values). |
| onPremisesUserPrincipalName | String | Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Microsoft Entra ID via Microsoft Entra Connect. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith). |
| otherMails | String collection | A list of other email addresses for the user; for example: "[email protected]", "[email protected]"]. Can store up to 250 values, each with a limit of 250 characters. NOTE: This property can't contain accent characters. Requires $select to retrieve. Supports $filter (eq, not, ge, le, in, startsWith, endsWith, /$count eq 0, /$count ne 0). This property is subject to [sensitive action restrictions; only specific privileged administrator roles can update it. |
| passwordPolicies | String | Specifies password policies for the user. This value is an enumeration with one possible value being DisableStrongPassword, which allows weaker passwords than the default policy to be specified. DisablePasswordExpiration can also be specified. The two might be specified together; for example: DisablePasswordExpiration, DisableStrongPassword. Requires $select to retrieve. For more information on the default password policies, see Microsoft Entra password policies. Supports $filter (ne, not, and eq on null values). |
| passwordProfile | passwordProfile | Specifies the password profile for the user. The profile contains the user's password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values). To update this property: This property is also subject to sensitive action restrictions. |
| pastProjects | String collection | A list for the user to enumerate their past projects. Requires $select to retrieve. |
| postalCode | String | The postal code for the user's postal address. The postal code is specific to the user's country or region. In the United States of America, this attribute contains the ZIP code. Maximum length is 40 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| preferredDataLocation | String | The preferred data location for the user. For more information, see OneDrive Online Multi-Geo. |
| preferredLanguage | String | The preferred language for the user. The preferred language format is based on RFC 4646. The name is a combination of an ISO 639 two-letter lowercase culture code associated with the language, and an ISO 3166 two-letter uppercase subculture code associated with the country or region. Example: "en-US", or "es-ES". Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values) |
| preferredName | String | The preferred name for the user. Not Supported. This attribute returns an empty string. Requires $select to retrieve. |
| provisionedPlans | provisionedPlan collection | The plans that are provisioned for the user. Read-only. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le). |
| proxyAddresses | String collection | For example: "SMTP: [email protected]", "smtp: [email protected]"]. Changes to the mail property update this collection to include the value as an SMTP address. For more information, see [mail and proxyAddresses properties. The proxy address prefixed with SMTP (capitalized) is the primary proxy address, while those addresses prefixed with smtp are the secondary proxy addresses. For Azure AD B2C accounts, this property has a limit of 10 unique addresses. Read-only in Microsoft Graph; you can update this property only through the Microsoft 365 admin center. Not nullable. Requires $select to retrieve. Supports $filter (eq, not, ge, le, startsWith, endsWith, /$count eq 0, /$count ne 0). |
| refreshTokensValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Requires $select to retrieve. Read-only. |
| responsibilities | String collection | A list for the user to enumerate their responsibilities. Requires $select to retrieve. |
| serviceProvisioningErrors | serviceProvisioningError collection | Errors published by a federated service describing a nontransient, service-specific error regarding the properties or link from a user object. Supports $filter (eq, not, for isResolved and serviceInstance). |
| schools | String collection | A list for the user to enumerate the schools they attended. Requires $select to retrieve. |
| securityIdentifier | String | Security identifier (SID) of the user, used in Windows scenarios. Read-only. Returned by default. Supports $select and $filter (eq, not, ge, le, startsWith). |
| showInAddressList | Boolean | Do not use in Microsoft Graph. Manage this property through the Microsoft 365 admin center instead. Represents whether the user should be included in the Outlook global address list. See Known issue. |
| signInActivity | signInActivity | Get the last signed-in date and request ID of the sign-in for a given user. Read-only. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le) but not with any other filterable properties. Note: |
| signInSessionsValidFromDateTime | DateTimeOffset | Any refresh tokens or session tokens (session cookies) issued before this time are invalid. Applications get an error when using an invalid refresh or session token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application needs to acquire a new refresh token by requesting the authorized endpoint. Read-only. Use revokeSignInSessions to reset. Requires $select to retrieve. |
| skills | String collection | A list for the user to enumerate their skills. Requires $select to retrieve. |
| state | String | The state or province in the user's address. Maximum length is 128 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| streetAddress | String | The street address of the user's place of business. Maximum length is 1,024 characters. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| surname | String | The user's surname (family name or last name). Maximum length is 64 characters. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| usageLocation | String | A two-letter country code (ISO standard 3166). Required for users that are assigned licenses due to legal requirements to check for availability of services in countries/regions. Examples include: US, JP, and GB. Not nullable. Requires $select to retrieve. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values). |
| userPrincipalName | String | The user principal name (UPN) of the user. The UPN is an Internet-style sign-in name for the user based on the Internet standard RFC 822. By convention, this value should map to the user's email name. The general format is alias@domain, where the domain must be present in the tenant's collection of verified domains. This property is required when a user is created. The verified domains for the tenant can be accessed from the verifiedDomains property of organization. NOTE: This property can't contain accent characters. Only the following characters are allowed A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. For the complete list of allowed characters, see username policies. Returned by default. Supports $filter (eq, ne, not, ge, le, in, startsWith, endsWith) and $orderby. This property is subject to sensitive action restrictions; only specific privileged administrator roles can update it. |
| userType | String | A string value that can be used to classify user types in your directory. The possible values are Member and Guest. Requires $select to retrieve. Supports $filter (eq, ne, not, in, and eq on null values). **N |