diff --git a/openapi/v1.0/default.yaml b/openapi/v1.0/default.yaml index d6c393f0..f8dd5510 100644 --- a/openapi/v1.0/default.yaml +++ b/openapi/v1.0/default.yaml @@ -13530,7 +13530,7 @@ paths: tags: - applications.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -13562,7 +13562,7 @@ paths: tags: - applications.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -13610,7 +13610,7 @@ paths: tags: - applications.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -13655,7 +13655,7 @@ paths: tags: - applications.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -13687,7 +13687,7 @@ paths: tags: - applications.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -14106,7 +14106,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -14183,7 +14183,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -14268,7 +14268,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -14353,7 +14353,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -14482,7 +14482,7 @@ paths: tags: - applications.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -14713,7 +14713,7 @@ paths: tags: - applications.synchronization summary: Update synchronizationTemplate - description: Update (override) the synchronization template associated with a given application. + description: Update (override) the synchronizationTemplate associated with a given application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 @@ -15146,7 +15146,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -15223,7 +15223,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -15308,7 +15308,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -15393,7 +15393,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -351034,6 +351034,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -359701,6 +359705,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -542996,7 +543004,7 @@ paths: tags: - servicePrincipals.synchronization summary: List synchronization jobs - description: List existing jobs for a given application instance (service principal). + description: List existing synchronizationJob objects for a given application instance (service principal). externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0 @@ -543057,7 +543065,7 @@ paths: tags: - servicePrincipals.synchronization summary: Create synchronizationJob - description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. + description: Create a new synchronizationJob with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0 @@ -543093,7 +543101,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationJob - description: Retrieve the existing synchronization job and its properties. + description: Retrieve an existing synchronizationJob and its properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0 @@ -543180,7 +543188,7 @@ paths: tags: - servicePrincipals.synchronization summary: Delete synchronizationJob - description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' + description: 'Stop the synchronizationJob, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0 @@ -543432,7 +543440,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -543464,7 +543472,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -543512,7 +543520,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -543557,7 +543565,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -543589,7 +543597,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -543645,7 +543653,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationSchema - description: Retrieve the schema for a given synchronization job or template. + description: Retrieve the synchronizationSchema for a given synchronization job or template. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0 @@ -543699,7 +543707,7 @@ paths: tags: - servicePrincipals.synchronization summary: Update synchronizationSchema - description: 'Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' + description: 'Update the synchronizationSchema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-update?view=graph-rest-1.0 @@ -544015,7 +544023,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -544092,7 +544100,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -544177,7 +544185,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -544262,7 +544270,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -544391,7 +544399,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -544427,7 +544435,7 @@ paths: tags: - servicePrincipals.synchronization summary: Add synchronization secrets - description: Provide credentials for establishing connectivity with the target system. + description: Provide credentials for establishing connectivity with the target system and store them in the synchronization resource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-serviceprincipal-put-synchronization?view=graph-rest-1.0 @@ -544485,7 +544493,7 @@ paths: tags: - servicePrincipals.synchronization summary: List existing synchronization templates - description: List the synchronization templates associated with a given application or service principal. + description: List synchronizationTemplate objects associated with a given application or service principal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0 @@ -545058,7 +545066,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -545135,7 +545143,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -545220,7 +545228,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -545305,7 +545313,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -803500,7 +803508,7 @@ components: nullable: true accountEnabled: type: boolean - description: '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).' + description: '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.' nullable: true ageGroup: type: string @@ -803530,7 +803538,7 @@ components: type: array items: type: string - description: '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).' + description: '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: type: string description: '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).' @@ -803689,7 +803697,7 @@ components: nullable: true mobilePhone: type: string - description: '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.' + description: '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.' nullable: true mySite: type: string @@ -803715,7 +803723,7 @@ components: description: '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. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Requires $select to retrieve. Supports $filter (eq, ne, not, in).' onPremisesImmutableId: type: string - description: '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).' + description: '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.' nullable: true onPremisesLastSyncDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -803748,7 +803756,7 @@ components: type: array items: type: string - description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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).' + description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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: type: string description: '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).' @@ -803758,7 +803766,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - type: object nullable: true - description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.' + description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role. This property is also subject to sensitive action restrictions.' pastProjects: type: array items: @@ -803857,7 +803865,7 @@ components: nullable: true userPrincipalName: type: string - description: '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.' + description: '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.' nullable: true userType: type: string @@ -822523,6 +822531,7 @@ components: properties: allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled: type: boolean + description: 'When true, allows on-premises directory sync clients to update the onPremisesObjectIdentifier property.' nullable: true blockCloudObjectTakeoverThroughHardMatchEnabled: type: boolean @@ -845587,6 +845596,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The tenant-level quarantine configuration that automatically halts a workflow when its threshold conditions are met. Optional. workflowScheduleIntervalInHours: maximum: 2147483647 minimum: -2147483648 @@ -846204,6 +846214,7 @@ components: properties: threshold: type: number + description: The maximum number of users a workflow run can process before the workflow is quarantined. format: int64 microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration: allOf: @@ -846307,6 +846318,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: number + description: The maximum percentage of in-scope users a workflow run can process before the workflow is quarantined. format: int32 microsoft.graph.identityGovernance.previewFailedTask: title: previewFailedTask @@ -846335,6 +846347,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineCondition' + description: The set of threshold conditions evaluated for the workflow. Each condition is either a countBasedQuarantineCondition or a percentageBasedQuarantineCondition. matchMode: $ref: '#/components/schemas/microsoft.graph.identityGovernance.matchMode' microsoft.graph.identityGovernance.quarantineDetails: @@ -846344,10 +846357,12 @@ components: quarantinedDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string + description: The date and time when the workflow was quarantined. format: date-time nullable: true quarantineReason: type: string + description: The reason the workflow was quarantined. nullable: true quarantineType: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineType' @@ -846657,6 +846672,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The threshold configuration that automatically halts the workflow when its conditions are met. microsoft.graph.identityGovernance.workflowsInsightsByCategory: title: workflowsInsightsByCategory type: object diff --git a/openapi/v1.0/graphexplorer.yaml b/openapi/v1.0/graphexplorer.yaml index 79848a2b..744f0417 100644 --- a/openapi/v1.0/graphexplorer.yaml +++ b/openapi/v1.0/graphexplorer.yaml @@ -16178,7 +16178,7 @@ paths: tags: - applications.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -16210,7 +16210,7 @@ paths: tags: - applications.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -16258,7 +16258,7 @@ paths: tags: - applications.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -16303,7 +16303,7 @@ paths: tags: - applications.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -16335,7 +16335,7 @@ paths: tags: - applications.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -16797,7 +16797,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -16874,7 +16874,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -16975,7 +16975,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -17070,7 +17070,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -17199,7 +17199,7 @@ paths: tags: - applications.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -17469,7 +17469,7 @@ paths: tags: - applications.synchronization summary: Update synchronizationTemplate - description: Update (override) the synchronization template associated with a given application. + description: Update (override) the synchronizationTemplate associated with a given application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 @@ -17945,7 +17945,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -18022,7 +18022,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -18123,7 +18123,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -18218,7 +18218,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -430012,6 +430012,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -442560,6 +442564,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -675748,7 +675756,7 @@ paths: tags: - servicePrincipals.synchronization summary: List synchronization jobs - description: List existing jobs for a given application instance (service principal). + description: List existing synchronizationJob objects for a given application instance (service principal). externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0 @@ -675832,7 +675840,7 @@ paths: tags: - servicePrincipals.synchronization summary: Create synchronizationJob - description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. + description: Create a new synchronizationJob with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0 @@ -675868,7 +675876,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationJob - description: Retrieve the existing synchronization job and its properties. + description: Retrieve an existing synchronizationJob and its properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0 @@ -675967,7 +675975,7 @@ paths: tags: - servicePrincipals.synchronization summary: Delete synchronizationJob - description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' + description: 'Stop the synchronizationJob, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0 @@ -676223,7 +676231,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -676255,7 +676263,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -676303,7 +676311,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -676348,7 +676356,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -676380,7 +676388,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -676436,7 +676444,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationSchema - description: Retrieve the schema for a given synchronization job or template. + description: Retrieve the synchronizationSchema for a given synchronization job or template. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0 @@ -676498,7 +676506,7 @@ paths: tags: - servicePrincipals.synchronization summary: Update synchronizationSchema - description: 'Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' + description: 'Update the synchronizationSchema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-update?view=graph-rest-1.0 @@ -676849,7 +676857,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -676926,7 +676934,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -677027,7 +677035,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -677122,7 +677130,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -677251,7 +677259,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -677287,7 +677295,7 @@ paths: tags: - servicePrincipals.synchronization summary: Add synchronization secrets - description: Provide credentials for establishing connectivity with the target system. + description: Provide credentials for establishing connectivity with the target system and store them in the synchronization resource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-serviceprincipal-put-synchronization?view=graph-rest-1.0 @@ -677345,7 +677353,7 @@ paths: tags: - servicePrincipals.synchronization summary: List existing synchronization templates - description: List the synchronization templates associated with a given application or service principal. + description: List synchronizationTemplate objects associated with a given application or service principal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0 @@ -678000,7 +678008,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -678077,7 +678085,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -678178,7 +678186,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -678273,7 +678281,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -991438,7 +991446,7 @@ components: nullable: true accountEnabled: type: boolean - description: '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).' + description: '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.' nullable: true ageGroup: type: string @@ -991468,7 +991476,7 @@ components: type: array items: type: string - description: '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).' + description: '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: type: string description: '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).' @@ -991627,7 +991635,7 @@ components: nullable: true mobilePhone: type: string - description: '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.' + description: '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.' nullable: true mySite: type: string @@ -991653,7 +991661,7 @@ components: description: '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. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Requires $select to retrieve. Supports $filter (eq, ne, not, in).' onPremisesImmutableId: type: string - description: '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).' + description: '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.' nullable: true onPremisesLastSyncDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -991686,7 +991694,7 @@ components: type: array items: type: string - description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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).' + description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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: type: string description: '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).' @@ -991696,7 +991704,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - type: object nullable: true - description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.' + description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role. This property is also subject to sensitive action restrictions.' pastProjects: type: array items: @@ -991795,7 +991803,7 @@ components: nullable: true userPrincipalName: type: string - description: '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.' + description: '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.' nullable: true userType: type: string @@ -1010461,6 +1010469,7 @@ components: properties: allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled: type: boolean + description: 'When true, allows on-premises directory sync clients to update the onPremisesObjectIdentifier property.' nullable: true blockCloudObjectTakeoverThroughHardMatchEnabled: type: boolean @@ -1033525,6 +1033534,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The tenant-level quarantine configuration that automatically halts a workflow when its threshold conditions are met. Optional. workflowScheduleIntervalInHours: maximum: 2147483647 minimum: -2147483648 @@ -1034142,6 +1034152,7 @@ components: properties: threshold: type: number + description: The maximum number of users a workflow run can process before the workflow is quarantined. format: int64 microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration: allOf: @@ -1034245,6 +1034256,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: number + description: The maximum percentage of in-scope users a workflow run can process before the workflow is quarantined. format: int32 microsoft.graph.identityGovernance.previewFailedTask: title: previewFailedTask @@ -1034273,6 +1034285,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineCondition' + description: The set of threshold conditions evaluated for the workflow. Each condition is either a countBasedQuarantineCondition or a percentageBasedQuarantineCondition. matchMode: $ref: '#/components/schemas/microsoft.graph.identityGovernance.matchMode' microsoft.graph.identityGovernance.quarantineDetails: @@ -1034282,10 +1034295,12 @@ components: quarantinedDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string + description: The date and time when the workflow was quarantined. format: date-time nullable: true quarantineReason: type: string + description: The reason the workflow was quarantined. nullable: true quarantineType: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineType' @@ -1034595,6 +1034610,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The threshold configuration that automatically halts the workflow when its conditions are met. microsoft.graph.identityGovernance.workflowsInsightsByCategory: title: workflowsInsightsByCategory type: object diff --git a/openapi/v1.0/openapi.yaml b/openapi/v1.0/openapi.yaml index e500ebaa..a10a5667 100644 --- a/openapi/v1.0/openapi.yaml +++ b/openapi/v1.0/openapi.yaml @@ -13505,7 +13505,7 @@ paths: tags: - applications.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -13539,7 +13539,7 @@ paths: tags: - applications.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -13589,7 +13589,7 @@ paths: tags: - applications.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -13636,7 +13636,7 @@ paths: tags: - applications.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -13670,7 +13670,7 @@ paths: tags: - applications.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -14031,7 +14031,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -14113,7 +14113,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -14201,7 +14201,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -14289,7 +14289,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -14425,7 +14425,7 @@ paths: tags: - applications.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -14657,7 +14657,7 @@ paths: tags: - applications.synchronization summary: Update synchronizationTemplate - description: Update (override) the synchronization template associated with a given application. + description: Update (override) the synchronizationTemplate associated with a given application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 @@ -15024,7 +15024,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -15106,7 +15106,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -15194,7 +15194,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -15282,7 +15282,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -400390,6 +400390,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows.workflow.clearQuarantine responses: 2XX: @@ -409226,6 +409230,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.workflows.workflow.clearQuarantine responses: 2XX: @@ -569674,7 +569682,7 @@ paths: tags: - servicePrincipals.synchronization summary: List synchronization jobs - description: List existing jobs for a given application instance (service principal). + description: List existing synchronizationJob objects for a given application instance (service principal). externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0 @@ -569730,7 +569738,7 @@ paths: tags: - servicePrincipals.synchronization summary: Create synchronizationJob - description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. + description: Create a new synchronizationJob with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0 @@ -569768,7 +569776,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationJob - description: Retrieve the existing synchronization job and its properties. + description: Retrieve an existing synchronizationJob and its properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0 @@ -569834,7 +569842,7 @@ paths: tags: - servicePrincipals.synchronization summary: Delete synchronizationJob - description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' + description: 'Stop the synchronizationJob, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0 @@ -570048,7 +570056,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -570082,7 +570090,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -570132,7 +570140,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -570179,7 +570187,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -570213,7 +570221,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -570271,7 +570279,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationSchema - description: Retrieve the schema for a given synchronization job or template. + description: Retrieve the synchronizationSchema for a given synchronization job or template. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0 @@ -570313,7 +570321,7 @@ paths: tags: - servicePrincipals.synchronization summary: Update synchronizationSchema - description: 'Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' + description: 'Update the synchronizationSchema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-update?view=graph-rest-1.0 @@ -570581,7 +570589,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -570663,7 +570671,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -570751,7 +570759,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -570839,7 +570847,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -570975,7 +570983,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -571013,7 +571021,7 @@ paths: tags: - servicePrincipals.synchronization summary: Add synchronization secrets - description: Provide credentials for establishing connectivity with the target system. + description: Provide credentials for establishing connectivity with the target system and store them in the synchronization resource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-serviceprincipal-put-synchronization?view=graph-rest-1.0 @@ -571085,7 +571093,7 @@ paths: tags: - servicePrincipals.synchronization summary: List existing synchronization templates - description: List the synchronization templates associated with a given application or service principal. + description: List synchronizationTemplate objects associated with a given application or service principal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0 @@ -571577,7 +571585,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -571659,7 +571667,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -571747,7 +571755,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -571835,7 +571843,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -796331,7 +796339,7 @@ components: nullable: true accountEnabled: type: boolean - description: '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).' + description: '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.' nullable: true ageGroup: type: string @@ -796361,7 +796369,7 @@ components: type: array items: type: string - description: '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).' + description: '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: type: string description: '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).' @@ -796520,7 +796528,7 @@ components: nullable: true mobilePhone: type: string - description: '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.' + description: '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.' nullable: true mySite: type: string @@ -796546,7 +796554,7 @@ components: description: '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. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Requires $select to retrieve. Supports $filter (eq, ne, not, in).' onPremisesImmutableId: type: string - description: '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).' + description: '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.' nullable: true onPremisesLastSyncDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -796579,7 +796587,7 @@ components: type: array items: type: string - description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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).' + description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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: type: string description: '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).' @@ -796589,7 +796597,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - type: object nullable: true - description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.' + description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role. This property is also subject to sensitive action restrictions.' pastProjects: type: array items: @@ -796688,7 +796696,7 @@ components: nullable: true userPrincipalName: type: string - description: '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.' + description: '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.' nullable: true userType: type: string @@ -819726,6 +819734,7 @@ components: properties: allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled: type: boolean + description: 'When true, allows on-premises directory sync clients to update the onPremisesObjectIdentifier property.' nullable: true blockCloudObjectTakeoverThroughHardMatchEnabled: type: boolean @@ -845395,6 +845404,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The tenant-level quarantine configuration that automatically halts a workflow when its threshold conditions are met. Optional. workflowScheduleIntervalInHours: maximum: 2147483647 minimum: -2147483648 @@ -846120,6 +846130,7 @@ components: properties: threshold: type: number + description: The maximum number of users a workflow run can process before the workflow is quarantined. format: int64 '@odata.type': type: string @@ -846270,6 +846281,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: number + description: The maximum percentage of in-scope users a workflow run can process before the workflow is quarantined. format: int32 '@odata.type': type: string @@ -846318,6 +846330,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineCondition' + description: The set of threshold conditions evaluated for the workflow. Each condition is either a countBasedQuarantineCondition or a percentageBasedQuarantineCondition. matchMode: $ref: '#/components/schemas/microsoft.graph.identityGovernance.matchMode' '@odata.type': @@ -846331,10 +846344,12 @@ components: quarantinedDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string + description: The date and time when the workflow was quarantined. format: date-time nullable: true quarantineReason: type: string + description: The reason the workflow was quarantined. nullable: true quarantineType: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineType' @@ -846722,6 +846737,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The threshold configuration that automatically halts the workflow when its conditions are met. '@odata.type': type: string microsoft.graph.identityGovernance.workflowsInsightsByCategory: diff --git a/openapi/v1.0/powershell_v2.yaml b/openapi/v1.0/powershell_v2.yaml index e89ff3ff..47c33b60 100644 --- a/openapi/v1.0/powershell_v2.yaml +++ b/openapi/v1.0/powershell_v2.yaml @@ -13790,7 +13790,7 @@ paths: tags: - applications.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -13822,7 +13822,7 @@ paths: tags: - applications.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -13870,7 +13870,7 @@ paths: tags: - applications.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -13915,7 +13915,7 @@ paths: tags: - applications.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -13947,7 +13947,7 @@ paths: tags: - applications.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -14374,7 +14374,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -14451,7 +14451,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -14536,7 +14536,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -14621,7 +14621,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -14750,7 +14750,7 @@ paths: tags: - applications.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -14990,7 +14990,7 @@ paths: tags: - applications.synchronization summary: Update synchronizationTemplate - description: Update (override) the synchronization template associated with a given application. + description: Update (override) the synchronizationTemplate associated with a given application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationtemplate-update?view=graph-rest-1.0 @@ -15435,7 +15435,7 @@ paths: tags: - applications.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -15512,7 +15512,7 @@ paths: tags: - applications.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -15597,7 +15597,7 @@ paths: tags: - applications.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -15682,7 +15682,7 @@ paths: tags: - applications.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -356044,6 +356044,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.deletedItems.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -364779,6 +364783,10 @@ paths: tags: - identityGovernance.lifecycleWorkflowsContainer summary: Invoke action clearQuarantine + description: 'Release a quarantined workflow so that it resumes processing. A workflow is automatically quarantined when a run exceeds the threshold conditions defined in its quarantineConfiguration. After an administrator reviews the cause of the quarantine, calling this action clears the quarantine state and allows the workflow to run again.' + externalDocs: + description: Find more info here + url: https://learn.microsoft.com/graph/api/identitygovernance-workflow-clearquarantine?view=graph-rest-1.0 operationId: identityGovernance.lifecycleWorkflows.workflows.workflow.clearQuarantine parameters: - name: workflow-id @@ -550558,7 +550566,7 @@ paths: tags: - servicePrincipals.synchronization summary: List synchronization jobs - description: List existing jobs for a given application instance (service principal). + description: List existing synchronizationJob objects for a given application instance (service principal). externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-jobs?view=graph-rest-1.0 @@ -550619,7 +550627,7 @@ paths: tags: - servicePrincipals.synchronization summary: Create synchronizationJob - description: Create new synchronization job with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. + description: Create a new synchronizationJob with a default synchronization schema. The job is created in a disabled state. Call Start job to start synchronization. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-post-jobs?view=graph-rest-1.0 @@ -550655,7 +550663,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationJob - description: Retrieve the existing synchronization job and its properties. + description: Retrieve an existing synchronizationJob and its properties. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-get?view=graph-rest-1.0 @@ -550746,7 +550754,7 @@ paths: tags: - servicePrincipals.synchronization summary: Delete synchronizationJob - description: 'Stop the synchronization job, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' + description: 'Stop the synchronizationJob, and permanently delete all the state associated with it. Synchronized accounts are left as-is.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-delete?view=graph-rest-1.0 @@ -551002,7 +551010,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action pause - description: 'Temporarily stop a running synchronization job. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' + description: 'Temporarily stop a running synchronizationJob. All the progress, including job state, is persisted, and the job will continue from where it left off when a start call is made.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-pause?view=graph-rest-1.0 @@ -551034,7 +551042,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action provisionOnDemand - description: Select a user and provision the account on-demand. The rate limit for this API is 5 requests per 10 seconds. + description: Select a user and provision the account on-demand for a synchronizationJob. The rate limit for this API is 5 requests per 10 seconds. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-provisionondemand?view=graph-rest-1.0 @@ -551082,7 +551090,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action restart - description: 'Restart a stopped synchronization job, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' + description: 'Restart a stopped synchronizationJob, forcing it to reprocess all the objects in the directory. Optionally clears existing the synchronization state and previous errors.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-restart?view=graph-rest-1.0 @@ -551127,7 +551135,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action start - description: 'Start an existing synchronization job. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' + description: 'Start an existing synchronizationJob. If the job is in a paused state, it continues processing changes from the point where it was paused. If the job is in quarantine, the quarantine status is cleared. Don''t create scripts to call the start job continuously while it''s running because that can cause the service to stop running. Use the start job only when the job is currently paused or in quarantine. ' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-start?view=graph-rest-1.0 @@ -551159,7 +551167,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action validateCredentials - description: Validate that the credentials are valid in the tenant. + description: Validate that the credentials are valid in the tenant for a synchronizationJob. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationjob-validatecredentials?view=graph-rest-1.0 @@ -551215,7 +551223,7 @@ paths: tags: - servicePrincipals.synchronization summary: Get synchronizationSchema - description: Retrieve the schema for a given synchronization job or template. + description: Retrieve the synchronizationSchema for a given synchronization job or template. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-get?view=graph-rest-1.0 @@ -551269,7 +551277,7 @@ paths: tags: - servicePrincipals.synchronization summary: Update synchronizationSchema - description: 'Update the synchronization schema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' + description: 'Update the synchronizationSchema for a given job or template. This method fully replaces the current schema with the one provided in the request. To update the schema of a template, make the call on the application object. You must be the owner of the application.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-update?view=graph-rest-1.0 @@ -551593,7 +551601,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -551670,7 +551678,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -551755,7 +551763,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -551840,7 +551848,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -551969,7 +551977,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action acquireAccessToken - description: Acquire an OAuth access token to authorize the Microsoft Entra provisioning service to provision users into an application. + description: Acquire an OAuth access token from the synchronization resource to authorize the Microsoft Entra provisioning service to provision users into an application. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-acquireaccesstoken?view=graph-rest-1.0 @@ -552005,7 +552013,7 @@ paths: tags: - servicePrincipals.synchronization summary: Add synchronization secrets - description: Provide credentials for establishing connectivity with the target system. + description: Provide credentials for establishing connectivity with the target system and store them in the synchronization resource. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-serviceprincipal-put-synchronization?view=graph-rest-1.0 @@ -552072,7 +552080,7 @@ paths: tags: - servicePrincipals.synchronization summary: List existing synchronization templates - description: List the synchronization templates associated with a given application or service principal. + description: List synchronizationTemplate objects associated with a given application or service principal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronization-list-templates?view=graph-rest-1.0 @@ -552657,7 +552665,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action discover - description: 'Discover the latest schema definition for provisioning to an application. ' + description: Discover the latest schema definition for provisioning to an application for the directoryDefinition. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-directorydefinition-discover?view=graph-rest-1.0 @@ -552734,7 +552742,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function filterOperators - description: List all operators supported in the scoping filters. + description: List all operators supported in the scoping filters for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-filteroperators?view=graph-rest-1.0 @@ -552819,7 +552827,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke function functions - description: List all the functions currently supported in the attributeMappingSource. + description: List all the functions currently supported in the attributeMappingSource for a synchronizationSchema. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-functions?view=graph-rest-1.0 @@ -552904,7 +552912,7 @@ paths: tags: - servicePrincipals.synchronization summary: Invoke action parseExpression - description: 'Parse a given string expression into an attributeMappingSource object. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' + description: 'Parse a given string expression into an attributeMappingSource object for a synchronizationSchema. For more information about expressions, see Writing Expressions for Attribute Mappings in Microsoft Entra ID.' externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/synchronization-synchronizationschema-parseexpression?view=graph-rest-1.0 @@ -813885,7 +813893,7 @@ components: nullable: true accountEnabled: type: boolean - description: '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).' + description: '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.' nullable: true ageGroup: type: string @@ -813915,7 +813923,7 @@ components: type: array items: type: string - description: '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).' + description: '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: type: string description: '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).' @@ -814074,7 +814082,7 @@ components: nullable: true mobilePhone: type: string - description: '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.' + description: '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.' nullable: true mySite: type: string @@ -814100,7 +814108,7 @@ components: description: '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. For an onPremisesSyncEnabled user, the source of authority for this set of properties is the on-premises and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties can be set during the creation or update of a user object. For a cloud-only user previously synced from on-premises Active Directory, these properties are read-only in Microsoft Graph but can be fully managed through the Exchange Admin Center or the Exchange Online V2 module in PowerShell. Requires $select to retrieve. Supports $filter (eq, ne, not, in).' onPremisesImmutableId: type: string - description: '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).' + description: '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.' nullable: true onPremisesLastSyncDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' @@ -814133,7 +814141,7 @@ components: type: array items: type: string - description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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).' + description: 'A list of other email addresses for the user; for example: [''bob@contoso.com'', ''Robert@fabrikam.com'']. 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: type: string description: '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).' @@ -814143,7 +814151,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.passwordProfile' - type: object nullable: true - description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role.' + description: '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: User-PasswordProfile.ReadWrite.All is the least privileged permission to update this property. In delegated scenarios, the User Administrator Microsoft Entra role is the least privileged admin role supported to update this property for nonadmin users. Privileged Authentication Administrator is the least privileged role that''s allowed to update this property for all administrators in the tenant. In general, the signed-in user must have a higher privileged administrator role as indicated in Who can reset passwords. In app-only scenarios, the calling app must be assigned a supported permission and at least the User Administrator Microsoft Entra role. This property is also subject to sensitive action restrictions.' pastProjects: type: array items: @@ -814242,7 +814250,7 @@ components: nullable: true userPrincipalName: type: string - description: '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.' + description: '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.' nullable: true userType: type: string @@ -832908,6 +832916,7 @@ components: properties: allowOnPremUpdateOfOnPremisesObjectIdentifierEnabled: type: boolean + description: 'When true, allows on-premises directory sync clients to update the onPremisesObjectIdentifier property.' nullable: true blockCloudObjectTakeoverThroughHardMatchEnabled: type: boolean @@ -855972,6 +855981,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The tenant-level quarantine configuration that automatically halts a workflow when its threshold conditions are met. Optional. workflowScheduleIntervalInHours: maximum: 2147483647 minimum: -2147483648 @@ -856589,6 +856599,7 @@ components: properties: threshold: type: number + description: The maximum number of users a workflow run can process before the workflow is quarantined. format: int64 microsoft.graph.identityGovernance.customTaskExtensionCallbackConfiguration: allOf: @@ -856692,6 +856703,7 @@ components: maximum: 2147483647 minimum: -2147483648 type: number + description: The maximum percentage of in-scope users a workflow run can process before the workflow is quarantined. format: int32 microsoft.graph.identityGovernance.previewFailedTask: title: previewFailedTask @@ -856720,6 +856732,7 @@ components: type: array items: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineCondition' + description: The set of threshold conditions evaluated for the workflow. Each condition is either a countBasedQuarantineCondition or a percentageBasedQuarantineCondition. matchMode: $ref: '#/components/schemas/microsoft.graph.identityGovernance.matchMode' microsoft.graph.identityGovernance.quarantineDetails: @@ -856729,10 +856742,12 @@ components: quarantinedDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string + description: The date and time when the workflow was quarantined. format: date-time nullable: true quarantineReason: type: string + description: The reason the workflow was quarantined. nullable: true quarantineType: $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineType' @@ -857042,6 +857057,7 @@ components: - $ref: '#/components/schemas/microsoft.graph.identityGovernance.quarantineConfiguration' - type: object nullable: true + description: The threshold configuration that automatically halts the workflow when its conditions are met. microsoft.graph.identityGovernance.workflowsInsightsByCategory: title: workflowsInsightsByCategory type: object