lifecycle_workflows_workflows_created_by_mailbox_settings

Creates, updates, deletes, gets or lists a lifecycle_workflows_workflows_created_by_mailbox_settings resource.

Overview

Name	lifecycle_workflows_workflows_created_by_mailbox_settings
Type	Resource
Id	entra_id.identity_governance.lifecycle_workflows_workflows_created_by_mailbox_settings

Fields

The following fields are returned by SELECT queries:

get

Entity result.

Name	Datatype	Description
archiveFolder	string	Folder ID of an archive folder for the user.
automaticRepliesSetting	object	Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user. (title: automaticRepliesSetting)
dateFormat	string	The date format for the user's mailbox.
delegateMeetingMessageDeliveryOptions	string	If the user has a calendar delegate, this specifies whether the delegate, mailbox owner, or both receive meeting messages and meeting responses. The possible values are: sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly. (sendToDelegateAndInformationToPrincipal, sendToDelegateAndPrincipal, sendToDelegateOnly) (title: delegateMeetingMessageDeliveryOptions)
language	object	The locale information for the user, including the preferred language and country/region. (title: localeInfo)
timeFormat	string	The time format for the user's mailbox.
timeZone	string	The default time zone for the user's mailbox.
userPurpose	string	The purpose of the mailbox. Differentiates a mailbox for a single user from a shared mailbox and equipment mailbox in Exchange Online. The possible values are: user, linked, shared, room, equipment, others, unknownFutureValue. Read-only. (user, linked, shared, room, equipment, others, unknownFutureValue) (title: userPurpose)
workingHours	object	The days of the week and hours in a specific time zone that the user works. (title: workingHours)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workflow_id		Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.
update	update	workflow_id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
workflow_id	string	The unique identifier of workflow

SELECT examples

get

Settings for the primary mailbox of the signed-in user. You can get or update settings for sending automatic replies to incoming messages, locale, and time zone. Requires $select to retrieve.

SELECT
archiveFolder,
automaticRepliesSetting,
dateFormat,
delegateMeetingMessageDeliveryOptions,
language,
timeFormat,
timeZone,
userPurpose,
workingHours
FROM entra_id.identity_governance.lifecycle_workflows_workflows_created_by_mailbox_settings
WHERE workflow_id = '{{ workflow_id }}' -- required
;

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.lifecycle_workflows_workflows_created_by_mailbox_settings
SET 
archiveFolder = '{{ archiveFolder }}',
automaticRepliesSetting = '{{ automaticRepliesSetting }}',
dateFormat = '{{ dateFormat }}',
delegateMeetingMessageDeliveryOptions = '{{ delegateMeetingMessageDeliveryOptions }}',
language = '{{ language }}',
timeFormat = '{{ timeFormat }}',
timeZone = '{{ timeZone }}',
userPurpose = '{{ userPurpose }}',
workingHours = '{{ workingHours }}',
WHERE 
workflow_id = '{{ workflow_id }}' --required
RETURNING
archiveFolder,
automaticRepliesSetting,
dateFormat,
delegateMeetingMessageDeliveryOptions,
language,
timeFormat,
timeZone,
userPurpose,
workingHours;