Skip to main content

O365 - EWS - Extension

This Integration is part of the EWS Pack.#

Supported versions

Supported Cortex XSOAR versions: 5.5.0 and later.

This integration enables you to manage and interact with Microsoft O365 - Exchange Online from within XSOAR. This integration was integrated and tested with version V1 of Exchange Online PowerShell.

Enable or disable access to Exchange Online PowerShell#

Exchange Online PowerShell enables you to manage your Exchange Online organization from the command line. By default, all accounts you create in Microsoft 365 are allowed to use Exchange Online PowerShell. Administrators can use Exchange Online PowerShell to enable or disable a user's ability to connect to Exchange Online PowerShell. Note that access to Exchange Online PowerShell doesn't give users extra administrative powers in your organization. A user's capabilities in Exchange Online PowerShell are still defined by a role based access control (RBAC) and the roles that are assigned to them.

For more info

Configure O365 - EWS - Extension on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for O365 - EWS - Extension.

  3. Authentication / Authorization methods:

    1. OAuth2.0 authorization (recommended):

      1. Click Add an instance to create and configure a new integration instance.

        ParameterDescriptionRequired
        urlEchange online URLTrue
        credentialsFill only Email (aka UPN), Password should be empty.False
        insecureTrust any certificate (not secure)False
      2. Open playground - War-room:

        1. Run the !ews-auth-start command and follow the instructions. Expected output is:

        EWS extension - Authorize instructions#

        1. To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code XXXXXXX to authenticate.
        2. Run the command !ews-auth-complete command in the War Room.
        1. Test - OAuth2.0 authorization, Run the !ews-auth-test command.
  4. Basic authentication (Not recommended):

    1. Click Add an instance to create and configure a new integration instance.

      ParameterDescriptionRequired
      urlSearch and Compliance URLTrue
      credentialsFill Email (aka UPN) and passwordFalse
      insecureTrust any certificate (not secure)False
    2. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

ews-auth-start#


OAuth2.0 - Start authorization.

Base Command#

ews-auth-start

Input#

There are no input arguments for this command.

Context Output#

There is no context output for this command.

Command Example#

!ews-auth-start

Human Readable Output#

EWS extension - Authorize instructions#

  1. To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code XXXXXXX to authenticate.
  2. Run the !ews-auth-complete command in the War Room.

ews-auth-complete#


Completes the OAuth2.0 authorization process.

Base Command#

ews-auth-complete

Input#

There are no input arguments for this command.

Context Output#

There is no context output for this command.

Command Example#

!ews-auth-complete

Human Readable Output#

Your account successfully authorized!

ews-auth-test#


Tests the OAuth2.0 authorization process.

Base Command#

ews-auth-test

Input#

There are no input arguments for this command.

Context Output#

There is no context output for this command.

Command Example#

!ews-auth-test

Human Readable Output#

Test ok!

ews-junk-rules-get#


Gets junk rules for the specified mailbox.

Base Command#

ews-junk-rules-get

Input#

Argument NameDescriptionRequired
mailboxID of the mailbox for which to get junk rules.Required

Context Output#

PathTypeDescription
EWS.Rule.Junk.BlockedSendersAndDomainsStringBlocked senders and domains list.
EWS.Rule.Junk.ContactsTrustedBooleanIf true, contacts are trusted by default.
EWS.Rule.Junk.EmailStringJunk rule mailbox.
EWS.Rule.Junk.EnabledBooleanIf true, junk rule is enabled.
EWS.Rule.Junk.IdentityStringJunk rule identity.
EWS.Rule.Junk.MailboxOwnerIdStringMail box owner ID.
EWS.Rule.Junk.TrustedListsOnlyBooleanIf true, only a list defined in the trusted lists are trusted.
EWS.Rule.Junk.TrustedRecipientsAndDomainsStringList of trusted recipients and domains.
EWS.Rule.Junk.TrustedSendersAndDomainsStringList of trusted senders and domains.

Command Example#

!ews-junk-rules-get mailbox="xsoar@dev.onmicrosoft.com"

Context Example#

{
"EWS": {
"Rule": {
"Junk": {
"BlockedSendersAndDomains": [
"user1@gmail.com",
"user2@gmail.com"
],
"ContactsTrusted": false,
"Enabled": false,
"Identity": "xsoar",
"MailboxOwnerId": "xsoar",
"TrustedListsOnly": false,
"TrustedRecipientsAndDomains": [
"user1@gmail.com",
"user2@gmail.com"
],
"TrustedSendersAndDomains": [
"user1@gmail.com",
"user2@gmail.com"
]
}
}
}
}

Human Readable Output#

EWS extension - 'xsoar@dev.onmicrosoft.com' Junk rules#

BlockedSendersAndDomainsContactsTrustedEnabledTrustedListsOnlyTrustedSendersAndDomains
["user1@gmail.com","user2@gmail.com"]FalseFalseFalse["user1@gmail.com","user2@gmail.com"]

ews-junk-rules-set#


Sets junk rules for the specified mailbox.

Base Command#

ews-junk-rules-set

Input#

Argument NameDescriptionRequired
mailboxID of the mailbox for which to set junk rules.Required
add_blocked_senders_and_domainsComma-separated list of blocked senders and domains to add to the mailbox.Optional
remove_blocked_senders_and_domainsComma-separated list of blocked senders and domains to remove from the mailbox.Optional
add_trusted_senders_and_domainsComma-separated list of trusted senders and domains to add to the mailbox.Optional
remove_trusted_senders_and_domainsComma-separated list of trusted senders and domains to remove from the mailbox.Optional
trusted_lists_onlyIf true, trust only lists defined in the trusted lists. Can be "true" or "false". Possible values are: true, false.Optional
contacts_trustedIf true, contacts are trusted by default. Can be "true" or "false". Possible values are: true, false.Optional
enabledIf true, the junk rule is enabled. Can be "true" or "false". Possible values are: true, false.Optional

Context Output#

There is no context output for this command.

Command Example#

!ews-junk-rules-set mailbox="xsoar@dev.onmicrosoft.com" add_blocked_senders_and_domains="test@gmail.com" add_trusted_senders_and_domains="dev.onmicrosoft.com"

Human Readable Output#

EWS extension - 'xsoar@dev.onmicrosoft.com' Junk rules modified!

ews-global-junk-rules-set#


Sets junk rules in all managed accounts.

Base Command#

ews-global-junk-rules-set

Input#

Argument NameDescriptionRequired
add_blocked_senders_and_domainsComma-separated list of blocked senders and domains to add to the mailbox.Optional
remove_blocked_senders_and_domainsComma-separated list of blocked senders and domains to remove from the mailbox.Optional
add_trusted_senders_and_domainsComma-separated list of trusted senders and domains to add to the mailbox.Optional
remove_trusted_senders_and_domainsComma-separated list of trusted senders and domains to remove from the mailbox.Optional
trusted_lists_onlyIf true, trust only lists defined in the trusted lists. Can be "true" or "false". Possible values are: true, false.Optional
contacts_trustedIf true, contacts are trusted by default. Can be "true" or "false". Possible values are: true, false.Optional
enabledIf true, the junk rule is enabled. Can be "true" or "false". Possible values are: true, false.Optional

Context Output#

There is no context output for this command.

Command Example#

!ews-global-junk-rules-set add_blocked_senders_and_domains="test@demisto.com" add_trusted_senders_and_domains="demisto.com"

Human Readable Output#

EWS extension - Junk rules globally modified!

ews-message-trace-get#


Searches message data for the last 10 days. If you run this command without any arguments, only data from the last 48 hours is returned. If you enter a start date that is older than 10 days, you will receive an error and the command will return no results. This command returns a maximum of 1,000,000 results, and will timeout on very large queries. If your query returns too many results, consider splitting it up using shorter start_date and end_date intervals.

Base Command#

ews-message-trace-get

Input#

Argument NameDescriptionRequired
sender_addressThe sender_address parameter filters the results by the sender's email address. You can specify multiple values separated by commas.
.
Optional
recipient_addressThe recipient_address parameter filters the results by the recipient's email address. You can specify multiple values separated by commas.
.
Optional
from_ipThe from_ip parameter filters the results by the source IP address.
For incoming messages, the value of from_ip is the public IP address of the SMTP email server that sent the message.
For outgoing messages from Exchange Online, the value is blank.
.
Optional
to_ipThe to_ip parameter filters the results by the destination IP address.
For outgoing messages, the value of to_ip is the public IP address in the resolved MX record for the destination domain.
For incoming messages to Exchange Online, the value is blank.
.
Optional
message_idThe message_id parameter filters the results by the Message-ID header field of the message.
This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message.
The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way.
Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example,"d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com").
.
Optional
message_trace_idThe message_trace_id parameter can be used with the recipient address to uniquely identify a message trace and obtain more details.
A message trace ID is generated for every message that's processed by the system.
.
Optional
pageThe page number of the results you want to view.
Can be an integer between 1 and 1000. The default value is 1.
. Default is 1.
Optional
page_sizeThe maximum number of entries per page.
Can be an integer between 1 and 5000. The default value is 100.
. Default is 100.
Optional
start_dateThe start date of the date range.
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy,
enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day.
If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
Valid input for this parameter is from 10 days - now ago. The default value is 48 hours ago.
.
Optional
end_dateThe end date of the date range.
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command.
For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018.
You can enter the date only, or you can enter the date and time of day.
If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018 5:00 PM".
Valid input for this parameter is from start_date - now. The default value is now.
.
Optional
statusThe status of the message. Can be one of the following:
GettingStatus: The message is waiting for status update.
Failed: Message delivery was attempted and it failed or the message was filtered as spam or malware, or by transport rules.
Pending: Message delivery is underway or was deferred and is being retried.
Delivered: The message was delivered to its destination.
Expanded: There was no message delivery because the message was addressed to a distribution group and the membership of the distribution was expanded.
Quarantined: The message was quarantined.
* FilteredAsSpam: The message was marked as spam.
. Possible values are: GettingStatus, Failed, Pending, Delivered, Expanded, Quarantined, FilteredAsSpam.
Optional

Context Output#

PathTypeDescription
EWS.MessageTrace.FromIPStringThe public IP address of the SMTP email server that sent the message.
EWS.MessageTrace.ToIPStringThe public IP address in the resolved MX record for the destination domain. For incoming messages to Exchange Online, the value is blank.
EWS.MessageTrace.IndexNumberMessage index in pagination. (Index starts from 0)
EWS.MessageTrace.MessageIdStringMessage-ID header field of the message.
EWS.MessageTrace.MessageTraceIdStringMessage trace ID of the message.
EWS.MessageTrace.OrganizationStringMessage trace organization source.
EWS.MessageTrace.ReceivedDateMessage receive time.
EWS.MessageTrace.RecipientAddressStringMessage recipients address.
EWS.MessageTrace.SenderAddressStringMessage sender address.
EWS.MessageTrace.SizeNumberMessage size in bytes.
EWS.MessageTrace.StartDateDateMessage trace start date.
EWS.MessageTrace.EndDateDateMessage trace end date.
EWS.MessageTrace.StatusStringMessage status.
EWS.MessageTrace.SubjectStringMessage subject.

Command Example#

!ews-message-trace-get

Context Example#

{
"EWS": {
"MessageTrace": [
{
"EndDate": "2021-01-03T06:14:14.9596257Z",
"FromIP": "8.8.8.8",
"Index": 1,
"MessageId": "xxx",
"MessageTraceId": "xxxx",
"Organization": "dev.onmicrosoft.com",
"Received": "2021-01-03T04:45:36.4662406",
"RecipientAddress": "xsoar@dev.onmicrosoft.com",
"SenderAddress": "xsoar@dev.onmicrosoft.com",
"Size": 1882,
"StartDate": "2021-01-01T06:14:14.9596257Z",
"Status": "GettingStatus",
"Subject": "Test mail",
"ToIP": null
},
{
"EndDate": "2021-01-03T06:15:14.9596257Z",
"FromIP": "8.8.8.8",
"Index": 2,
"MessageId": "xxx",
"MessageTraceId": "xxxx",
"Organization": "dev.onmicrosoft.com",
"Received": "2021-01-03T04:46:36.4662406",
"RecipientAddress": "xsoar@dev.onmicrosoft.com",
"SenderAddress": "xsoar@dev.onmicrosoft.com",
"Size": 1882,
"StartDate": "2021-01-01T06:15:14.9596257Z",
"Status": "GettingStatus",
"Subject": "Test mail",
"ToIP": null
}
]
}
}

Human Readable Output#

EWS extension - Messages trace#

EndDateFromIPIndexMessageIdMessageTraceIdOrganizationReceivedRecipientAddressSenderAddressSizeStartDateStatusSubjectToIP
1/3/2021 6:14:14 AM8.8.8.80xxxxxxxmicrosoft.com1/3/2021 4:45:36 AMxsoar@dev.microsoft.comxsoar@dev.onmicrosoft.com69751/1/2021 6:14:14 AMDeliveredTest mail
1/3/2021 6:15:14 AM8.8.8.81xxxxxxxmicrosoft.com1/3/2021 4:46:36 AMxsoar@dev.microsoft.comxsoar@dev.onmicrosoft.com69751/1/2021 6:15:14 AMDeliveredTest mail

ews-federation-trust-get#


Displays the federation trust configured for the Exchange organization.

Base Command#

ews-federation-trust-get

Input#

Argument NameDescriptionRequired
domain_controllerThe domain controller identified by its fully qualified domain name (FQDN). For example, dc01.example.com. This argument is available only in on-premises Exchange.Optional
identityThe federation trust ID. If not specified, the command returns all federation trusts configured for the Exchange organization.Optional

Context Output#

PathTypeDescription
EWS.FederationTrust.AdminDisplayNameStringAdministrator display name of the federation trust.
EWS.FederationTrust.ApplicationIdentifierStringApplication identifier of the federation trust.
EWS.FederationTrust.ApplicationUriStringApplication URI of the federation trust.
EWS.FederationTrust.DistinguishedNameStringDistinguished name of the federation trust.
EWS.FederationTrust.ExchangeObjectIdStringExchange object ID of the federation trust.
EWS.FederationTrust.ExchangeVersionStringExchange version of the federation trust.
EWS.FederationTrust.GuidStringGUID of the federation trust.
EWS.FederationTrust.IdStringID of the federation trust.
EWS.FederationTrust.IdentityStringIdentity of the federation trust.
EWS.FederationTrust.IsValidBooleanWhether the federation trust is valid.
EWS.FederationTrust.MetadataEprStringMetadata EPR of the federation trust.
EWS.FederationTrust.MetadataPollIntervalDateMetadata poll interval of the federation trust.
EWS.FederationTrust.MetadataPutEprUnknownMetadata put EPR of the federation trust.
EWS.FederationTrust.NameStringName of the federation trust.
EWS.FederationTrust.NamespaceProvisionerStringNamespace provisioner of the federation trust.
EWS.FederationTrust.ObjectCategoryStringObject category of the federation trust.
EWS.FederationTrust.ObjectClassStringObject class of the federation trust.
EWS.FederationTrust.ObjectStateStringObject state of the federation trust.
EWS.FederationTrust.OrgCertificate.ArchivedBooleanWhether the organization certificate of the federation trust is archived.
EWS.FederationTrust.OrgCertificate.Extensions.CriticalBooleanWhether the extensions of the organization certificate are critical.
EWS.FederationTrust.OrgCertificate.Extensions.Oid.FriendlyNameStringFriendly name of the OID of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.Oid.ValueStringValue of the OID of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.RawDataNumberRaw data of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.SubjectKeyIdentifierStringSubject key identifier of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.KeyUsagesNumberKey usages of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.EnhancedKeyUsages.FriendlyNameStringFriendly name of the enhanced key usages of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.EnhancedKeyUsages.ValueStringValue of the enhanced key usages of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.Extensions.CertificateAuthorityBooleanWhether the organization certificate extensions have a certificate authority.
EWS.FederationTrust.OrgCertificate.Extensions.HasPathLengthConstraintBooleanWhether the organization certificate extensions have a path length constraint.
EWS.FederationTrust.OrgCertificate.Extensions.PathLengthConstraintNumberPath length constraint of the organization certificate extensions.
EWS.FederationTrust.OrgCertificate.FriendlyNameStringFriendly name of the organization certificate.
EWS.FederationTrust.OrgCertificate.Handle.valueNumberThe handle value of the organization certificate.
EWS.FederationTrust.OrgCertificate.HasPrivateKeyBooleanWhether the organization certificate has a private key.
EWS.FederationTrust.OrgCertificate.IssuerStringIssuer of the organization certificate.
EWS.FederationTrust.OrgCertificate.IssuerName.NameStringName of the issuer of the organization certificate.
EWS.FederationTrust.OrgCertificate.IssuerName.Oid.FriendlyNameUnknownFriendly Name of the OID of the issuer name of the organization certificate.
EWS.FederationTrust.OrgCertificate.IssuerName.Oid.ValueUnknownValue of the OID of the issuer name of the organization certificate.
EWS.FederationTrust.OrgCertificate.IssuerName.RawDataNumberRaw data of the issuer name of the organization certificate.
EWS.FederationTrust.OrgCertificate.NotAfterDateThe date until when the organization certificate is valid.
EWS.FederationTrust.OrgCertificate.NotBeforeDateThe date the organization certificate became valid.
EWS.FederationTrust.OrgCertificate.PrivateKeyUnknownPrivate key of the organization certificate.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedKeyValue.Oid.FriendlyNameStringFriendly name of the OID of the encoded key value of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedKeyValue.Oid.ValueStringValue of the OID of the encoded key value of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedKeyValue.RawDataNumberRaw data of the encoded key value of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedParameters.Oid.FriendlyNameStringFriendly name of the OID of the encoded parameters of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedParameters.Oid.ValueStringValue of the OID of the encoded parameters of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.EncodedParameters.RawDataNumberRaw data of the encoded parameters of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Key.KeyExchangeAlgorithmStringKey exchange algorithm of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Key.LegalKeySizes.MaxSizeNumberMaximum size of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Key.LegalKeySizes.MinSizeNumberMinimum size of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Key.LegalKeySizes.SkipSizeNumberSkipSize of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Key.SignatureAlgorithmStringSignature algorithm of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Oid.FriendlyNameStringFriendly name of the OID of the public key.
EWS.FederationTrust.OrgCertificate.PublicKey.Oid.ValueStringValue of the OID of the public key.
EWS.FederationTrust.OrgCertificate.RawDataNumberRaw data of the organization certificate.
EWS.FederationTrust.OrgCertificate.SerialNumberStringSerial number of the organization certificate.
EWS.FederationTrust.OrgCertificate.SignatureAlgorithm.FriendlyNameStringFriendly name of the signature algorithm.
EWS.FederationTrust.OrgCertificate.SignatureAlgorithm.ValueStringValue of the signature algorithm.
EWS.FederationTrust.OrgCertificate.SubjectStringSubject of the organization certificate.
EWS.FederationTrust.OrgCertificate.SubjectName.NameStringName of the subject of the organization certificate.
EWS.FederationTrust.OrgCertificate.SubjectName.Oid.FriendlyNameUnknownFriendly name of the OID of the subject name.
EWS.FederationTrust.OrgCertificate.SubjectName.Oid.ValueUnknownValue of the OID of the subject name.
EWS.FederationTrust.OrgCertificate.SubjectName.RawDataNumberRaw Data of the subject name.
EWS.FederationTrust.OrgCertificate.ThumbprintStringThumbprint of the organization certificate.
EWS.FederationTrust.OrgCertificate.VersionNumberVersion of the organization certificate.
EWS.FederationTrust.OrgNextCertificateUnknownNext organization certificate.
EWS.FederationTrust.OrgNextPrivCertificateStringNext organization private certificate.
EWS.FederationTrust.OrgPrevCertificate.ArchivedBooleanWhether to archive the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.Extensions.CriticalBooleanWhether the extensions of the previous organization certificate are critical.
EWS.FederationTrust.OrgPrevCertificate.Extensions.Oid.FriendlyNameStringFriendly name of the OID of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.Oid.ValueStringValue of the OID of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.RawDataNumberRaw data of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.SubjectKeyIdentifierStringSubject key identifier of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.KeyUsagesNumberKey usages of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.EnhancedKeyUsages.FriendlyNameStringFriendly name of the enhanced key usages of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.Extensions.EnhancedKeyUsages.ValueStringValue of the enhanced key usages of the previous organization certificate extensions.
EWS.FederationTrust.OrgPrevCertificate.FriendlyNameStringFriendly name of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.Handle.valueNumberValue of the handle of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.HasPrivateKeyBooleanWhether the previous organization certificate has a private key.
EWS.FederationTrust.OrgPrevCertificate.IssuerStringIssuer of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.IssuerName.NameStringName of the issuer of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.IssuerName.Oid.FriendlyNameUnknownFriendly name of the OID of the issuer of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.IssuerName.Oid.ValueUnknownValue of the OID of the issuer of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.IssuerName.RawDataNumberRaw data of the issuer of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.NotAfterDateThe date until when the previous organization certificate is valid.
EWS.FederationTrust.OrgPrevCertificate.NotBeforeDateThe date the previous organization certificate became valid.
EWS.FederationTrust.OrgPrevCertificate.PrivateKeyUnknownPrivate Key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedKeyValue.Oid.FriendlyNameStringFriendly Name of the OID of the encoded key value of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedKeyValue.Oid.ValueStringValue of the OID of the encoded key value of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedKeyValue.RawDataNumberRaw Data of the encoded key value of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedParameters.Oid.FriendlyNameStringFriendly name of the OID of the encoded parameters of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedParameters.Oid.ValueStringValue of the OID of the encoded parameters of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.EncodedParameters.RawDataNumberRaw Data of the encoded parameters of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Key.KeyExchangeAlgorithmStringKey exchange algorithm of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Key.LegalKeySizes.MaxSizeNumberMaximum size of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Key.LegalKeySizes.MinSizeNumberMinimum size of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Key.LegalKeySizes.SkipSizeNumberSkiPSize of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Key.SignatureAlgorithmStringSignature algorithm of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Oid.FriendlyNameStringFriendly name of the OID of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.PublicKey.Oid.ValueStringValue of the OID of the public key of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.RawDataNumberRaw Data of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SerialNumberStringSerial number of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SignatureAlgorithm.FriendlyNameStringFriendly name of the signature algorithm of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SignatureAlgorithm.ValueStringValue of the signature algorithm of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SubjectStringSubject of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SubjectName.NameStringName of the subject of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SubjectName.Oid.FriendlyNameUnknownFriendly name of the OID of the subject of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SubjectName.Oid.ValueUnknownValue of the OID of the subject name of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.SubjectName.RawDataNumberRaw Data of the subject name of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.ThumbprintStringThumbprint of the previous organization certificate.
EWS.FederationTrust.OrgPrevCertificate.VersionNumberVersion of the previous organization certificate.
EWS.FederationTrust.OrgPrevPrivCertificateStringOrganization previous private certificate.
EWS.FederationTrust.OrgPrivCertificateStringOrganization private certificate.
EWS.FederationTrust.OrganizationIdStringOrganization ID.
EWS.FederationTrust.OriginatingServerStringOriginating server.
EWS.FederationTrust.PSComputerNameStringPowerShell computer name.
EWS.FederationTrust.PSShowComputerNameBooleanWhether to show the PowerShell computer name.
EWS.FederationTrust.PolicyReferenceUriStringPolicy Reference URI.
EWS.FederationTrust.RunspaceIdStringRunspace ID.
EWS.FederationTrust.TimesOfUnmatchPartnerNumberTimes Of unmatch partner.
EWS.FederationTrust.TokenIssuerCertReferenceStringToken issuer certificate reference.
EWS.FederationTrust.TokenIssuerCertificate.ArchivedBooleanWhether the token issuer certificate is archived.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.CriticalBooleanWhether the extensions of the token issuer certificate are critical.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.Oid.FriendlyNameStringFriendly name of the OID of the extensions of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.Oid.ValueStringValue of the OID of the extensions of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.RawDataNumberRaw Data of the extensions of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.SubjectKeyIdentifierStringSubject key identifier of the extensions of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.Extensions.KeyUsagesNumberKey usages of the extensions of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.FriendlyNameStringFriendly name of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.Handle.valueNumberValue of the handle of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.HasPrivateKeyBooleanWhether the token issuer certificate has a private key.
EWS.FederationTrust.TokenIssuerCertificate.IssuerStringIssuer of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.IssuerName.NameStringName of the issuer of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.IssuerName.Oid.FriendlyNameUnknownFriendly name of the OID of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.IssuerName.Oid.ValueUnknownValue of the OID of the issuer of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.IssuerName.RawDataNumberRaw data of the issuer of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.NotAfterDateThe date until when the token issuer certificate is valid.
EWS.FederationTrust.TokenIssuerCertificate.NotBeforeDateThe date the token issuer certificate became valid.
EWS.FederationTrust.TokenIssuerCertificate.PrivateKeyUnknownPrivate key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedKeyValue.Oid.FriendlyNameStringFriendly name of the OID of the encoded key value of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedKeyValue.Oid.ValueStringValue of the OID of the encoded key value of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedKeyValue.RawDataNumberRaw data of the encoded key value of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedParameters.Oid.FriendlyNameStringFriendly name of the OID of the encoded parameters of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedParameters.Oid.ValueStringValue of the OID of the encoded parameters of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.EncodedParameters.RawDataNumberRaw Data of the encoded parameters of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Key.KeyExchangeAlgorithmStringKey exchange algorithm of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Key.LegalKeySizes.MaxSizeNumberMaximum size of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Key.LegalKeySizes.MinSizeNumberMinimum size of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Key.LegalKeySizes.SkipSizeNumberSkiPSize of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Key.SignatureAlgorithmStringSignature algorithm of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Oid.FriendlyNameStringFriendly name of the OID of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.PublicKey.Oid.ValueStringValue of the OID of the public key of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.RawDataNumberRaw Data of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SerialNumberStringSerial number of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SignatureAlgorithm.FriendlyNameStringFriendly name of the signature algorithm of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SignatureAlgorithm.ValueStringValue of the signature algorithm of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SubjectStringSubject of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SubjectName.NameStringName of the subject of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SubjectName.Oid.FriendlyNameUnknownFriendly name of the OID of the subject of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SubjectName.Oid.ValueUnknownValue of the OID of the subject of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.SubjectName.RawDataNumberRaw data of the subject of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.ThumbprintStringThumbprint of the token issuer certificate.
EWS.FederationTrust.TokenIssuerCertificate.VersionNumberVersion of the token issuer certificate.
EWS.FederationTrust.TokenIssuerEprStringToken issuer EPR.
EWS.FederationTrust.TokenIssuerMetadataEprStringToken issuer metadata EPR.
EWS.FederationTrust.TokenIssuerPrevCertReferenceStringToken issuer previous certificate reference.
EWS.FederationTrust.TokenIssuerPrevCertificate.ArchivedBooleanWhether the token issuer previous certificate was archived.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.CriticalBooleanWhether the extensions of the token issuer previous certificate was critical.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.Oid.FriendlyNameStringFriendly name of the OID of the extensions of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.Oid.ValueStringValue of the OID of the extensions of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.RawDataNumberRaw data of the extensions of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.SubjectKeyIdentifierStringSubject key identifier of the extensions of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.Extensions.KeyUsagesNumberKey usages of the extensions of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.FriendlyNameStringFriendly name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.Handle.valueNumberThe handle value of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.HasPrivateKeyBooleanWhether the token issuer previous certificate has a private key.
EWS.FederationTrust.TokenIssuerPrevCertificate.IssuerStringIssuer of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.IssuerName.NameStringName of the issuer of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.IssuerName.Oid.FriendlyNameUnknownFriendly name of the OID of the issuer name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.IssuerName.Oid.ValueUnknownValue of the OID of the issuer name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.IssuerName.RawDataNumberRaw Data of the issuer name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.NotAfterDateThe date until when the token issuer previous certificate is valid.
EWS.FederationTrust.TokenIssuerPrevCertificate.NotBeforeDateThe date the token issuer previous certificate became valid.
EWS.FederationTrust.TokenIssuerPrevCertificate.PrivateKeyUnknownPrivate Key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedKeyValue.Oid.FriendlyNameStringFriendly name of the OID of the encoded key value of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedKeyValue.Oid.ValueStringValue of the OID of the encoded key value of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedKeyValue.RawDataNumberRaw data of the encoded key value of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedParameters.Oid.FriendlyNameStringFriendly name of the OID of the encoded parameters of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedParameters.Oid.ValueStringValue of the OID of the encoded parameters of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.EncodedParameters.RawDataNumberRaw data of the encoded parameters of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Key.KeyExchangeAlgorithmStringKey exchange algorithm of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Key.LegalKeySizes.MaxSizeNumberMaximum size of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Key.LegalKeySizes.MinSizeNumberMinimum size of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Key.LegalKeySizes.SkipSizeNumberSkiPSize of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Key.SignatureAlgorithmStringSignature algorithm of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Oid.FriendlyNameStringFriendly Name of the OID of the public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.PublicKey.Oid.ValueStringValue of the OID of teh public key of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.RawDataNumberRaw Data of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SerialNumberStringSerial number of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SignatureAlgorithm.FriendlyNameStringFriendly name of the signature algorithm of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SignatureAlgorithm.ValueStringValue of the signature algorithm of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SubjectStringSubject of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SubjectName.NameStringName of the subject of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SubjectName.Oid.FriendlyNameUnknownFriendly Name of the OID of the subject of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SubjectName.Oid.ValueUnknownValue of the OID of the subject name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.SubjectName.RawDataNumberRaw data of the subject name of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.ThumbprintStringThumbprint of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerPrevCertificate.VersionNumberVersion of the token issuer previous certificate.
EWS.FederationTrust.TokenIssuerTypeStringToken issuer type of the federation trust.
EWS.FederationTrust.TokenIssuerUriStringToken Issuer UIR of the federation trust.
EWS.FederationTrust.WebRequestorRedirectEprStringWeb requestor redirect EPR of the federation trust.
EWS.FederationTrust.WhenChangedDateThe date the federation trust was changed.
EWS.FederationTrust.WhenChangedUTCDateThe date in UTC format of when the federation trust was changed.
EWS.FederationTrust.WhenCreatedDateThe date the federation trust was created.
EWS.FederationTrust.WhenCreatedUTCDateThe date in UTC format of when the federation trust was created.

ews-federation-configuration-get#


Retrieves the Exchange organization's federated organization identifier and related details, such as federated domains, organization contact, and status.

Base Command#

ews-federation-configuration-get

Input#

Argument NameDescriptionRequired
domain_controllerThe fully qualified domain name (FQDN) of the domain controller. For example, dc01.example.com. This argument is available only in on-premises Exchange.Optional
identityThe federation trust ID. If not specified, all federation trusts configured for the Exchange organization are returned.Optional
include_extended_domain_infoThe IncludeExtendedDomainInfo switch specifies that the command query Microsoft Federation Gateway for the status of each accepted domain that's federated. The status is returned with each domain in the Domains property. Possible values: "true" and "false". Possible values are: true, false. Default is false.Optional

Context Output#

PathTypeDescription
EWS.FederationConfiguration.AccountNamespaceStringAccount namespace of the federation configuration.
EWS.FederationConfiguration.DefaultDomainUnknownDefault domain of the federation configuration.
EWS.FederationConfiguration.DelegationTrustLinkStringDelegation trust link of the federation configuration.
EWS.FederationConfiguration.DistinguishedNameStringDistinguished name of the federation configuration.
EWS.FederationConfiguration.DomainsStringDomains of the federation configuration.
EWS.FederationConfiguration.EnabledBooleanWhether the federation configuration is enabled.
EWS.FederationConfiguration.ExchangeObjectIdStringExchange object ID of the federation configuration.
EWS.FederationConfiguration.ExchangeVersionStringExchange version of the federation configuration.
EWS.FederationConfiguration.GuidStringGUID of the federation configuration.
EWS.FederationConfiguration.IdStringID of the federation configuration.
EWS.FederationConfiguration.IdentityStringIdentity of the federation configuration.
EWS.FederationConfiguration.IsValidBooleanWhether the federation configration is valid.
EWS.FederationConfiguration.NameStringName of the federation configuration.
EWS.FederationConfiguration.ObjectCategoryStringObject category of the federation configuration.
EWS.FederationConfiguration.ObjectClassStringObject class of the federation configuration.
EWS.FederationConfiguration.ObjectStateStringObject state of the federation configuration.
EWS.FederationConfiguration.OrganizationContactStringOrganization contact of the federation configuration.
EWS.FederationConfiguration.OrganizationIdStringOrganization ID of the federation configuration.
EWS.FederationConfiguration.OriginatingServerStringOriginating server of the federation configuration.
EWS.FederationConfiguration.PSComputerNameStringPowerShell computer name of the federation configuration.
EWS.FederationConfiguration.PSShowComputerNameBooleanWhether to show the PowerShell computer name of the federation configuration.
EWS.FederationConfiguration.RunspaceIdStringRunspace ID of the federation configuration.
EWS.FederationConfiguration.WhenChangedDateThe date the federation configuration was changed.
EWS.FederationConfiguration.WhenChangedUTCDateThe date in UTC format of when the federation configuration was changed.
EWS.FederationConfiguration.WhenCreatedDateThe date the federation configuration was created.
EWS.FederationConfiguration.WhenCreatedUTCDateThe date in UTC format of when the federation configuration was created.

ews-remote-domain-get#


Gets the configuration information for the remote domains configured in your organization. This command is available only in the Exchange Online PowerShell V2 module.

Base Command#

ews-remote-domain-get

Input#

Argument NameDescriptionRequired
domain_controllerThe fully qualified domain name (FQDN) of the domain controller. For example, dc01.example.com.
This argument is available only in on-premises Exchange.
Optional
identityThe remote domain that you want to view. You can use the GUID, ID, or any other identifier.Optional

Context Output#

PathTypeDescription
EWS.RemoteDomain.AdminDisplayNameStringAdmin display name of the remote domain.
EWS.RemoteDomain.AllowedOOFTypeStringAllowed OOF type of the remote domain.
EWS.RemoteDomain.AutoForwardEnabledBooleanWhether auto forward is enabled for the remote domain.
EWS.RemoteDomain.AutoReplyEnabledBooleanWhether auto reply is enabled for the remote domain..
EWS.RemoteDomain.ByteEncoderTypeFor7BitCharsetsStringByte encoder type For 7-bit charsets of the remote domain.
EWS.RemoteDomain.CharacterSetStringCharacter set of the remote domain.
EWS.RemoteDomain.ContentTypeStringContent type of the remote domain.
EWS.RemoteDomain.DeliveryReportEnabledBooleanWhether delivery report is enabled for the remote domain.
EWS.RemoteDomain.DisplaySenderNameBooleanWhether to display the sender name for the remote domain.
EWS.RemoteDomain.DistinguishedNameStringDistinguished name of the remote domain.
EWS.RemoteDomain.DomainNameStringDomain name of the remote domain.
EWS.RemoteDomain.ExchangeObjectIdStringExchange object ID of the remote domain.
EWS.RemoteDomain.ExchangeVersionStringExchange version of the remote domain.
EWS.RemoteDomain.GuidStringGUID of the remote domain.
EWS.RemoteDomain.IdStringID of the remote domain.
EWS.RemoteDomain.IdentityStringIdentity of the remote domain.
EWS.RemoteDomain.IsInternalBooleanWhether the remote domain is internal.
EWS.RemoteDomain.IsValidBooleanWhether the remote domain is valid.
EWS.RemoteDomain.LineWrapSizeStringLine wrap size for the remote domain.
EWS.RemoteDomain.MeetingForwardNotificationEnabledBooleanWhether meeting forward notification is enabled for the remote domain.
EWS.RemoteDomain.MessageCountThresholdNumberMessage count threshold of the remote domain.
EWS.RemoteDomain.NDRDiagnosticInfoEnabledBooleanWhether NDR diagnostic information is enabled for the remote domain.
EWS.RemoteDomain.NDREnabledBooleanWhether NDR is enabled for the remote domain.
EWS.RemoteDomain.NameStringName of the remote domain.
EWS.RemoteDomain.NonMimeCharacterSetStringNon-mime character set of the remote domain.
EWS.RemoteDomain.ObjectCategoryStringObject category of the remote domain.
EWS.RemoteDomain.ObjectClassStringObject class of the remote domain.
EWS.RemoteDomain.ObjectStateStringObject state of the remote domain.
EWS.RemoteDomain.OrganizationIdStringOrganization ID of the remote domain.
EWS.RemoteDomain.OriginatingServerStringOriginating server of the remote domain.
EWS.RemoteDomain.PSComputerNameStringPowerShell computer name of the remote domain.
EWS.RemoteDomain.PSShowComputerNameBooleanWhether to show the PowerShell computer name for the remote domain.
EWS.RemoteDomain.PreferredInternetCodePageForShiftJisStringPreferred internet code page for shift JIS for the remote domain.
EWS.RemoteDomain.RequiredCharsetCoverageUnknownRequired charset coverage for the remote domain.
EWS.RemoteDomain.RunspaceIdStringRunspace ID for the remote domain.
EWS.RemoteDomain.TNEFEnabledUnknownWhether TNEF is enabled for the remote domain.
EWS.RemoteDomain.TargetDeliveryDomainBooleanWhether the remote domain is used for the target email address of mail users that represent the users in the other forest.
EWS.RemoteDomain.TrustedMailInboundEnabledBooleanWhether inbound trusted mail is enabled.
EWS.RemoteDomain.TrustedMailOutboundEnabledBooleanWhether outbound trusted mail is enabled.
EWS.RemoteDomain.UseSimpleDisplayNameBooleanWhether to use the simple display name.
EWS.RemoteDomain.WhenChangedDateThe date the remote domain was changed.
EWS.RemoteDomain.WhenChangedUTCDateThe date in UTC format of when the remote domain was changed.
EWS.RemoteDomain.WhenCreatedDateThe date the remote domain was created.
EWS.RemoteDomain.WhenCreatedUTCDateThe date in UTC format of when the remote domain was created.

ews-user-list#


Displays the existing user objects in your organization.

Base Command#

ews-user-list

Input#

Argument NameDescriptionRequired
identityThe mailbox you want to view.Optional
organizational_unitThe object's location in Active Directory by which to filter the results.Optional
limitMaximum number of users to get. A value of 0 means to get all users. Default is 10.Optional

Context Output#

PathTypeDescription
EWS.User.AccountDisabledBooleanWhether the user account is disabled.
EWS.User.AllowUMCallsFromNonUsersBooleanWhether to allow Unified Messaging calls from non-users.
EWS.User.ArchiveReleaseStringThe archive release of the user object.
EWS.User.AssistantNameStringThe assistant name of the user object.
EWS.User.AuthenticationPolicyUnknownThe authentication policy of the user object.
EWS.User.CanHaveCloudCacheBooleanWhether the user object can have cloud cache.
EWS.User.CityStringThe city of the user object.
EWS.User.CloudCacheAccountTypeStringCloud cache account type of the user object.
EWS.User.CloudCacheProviderNumberCloud cache provider of the user object.
EWS.User.CloudCacheRemoteEmailAddressStringCloud cache remote email address of the user object.
EWS.User.CloudCacheScopeNumberCloud cache scope of the user object.
EWS.User.CloudCacheUserNameStringCloud cache user name of the user object.
EWS.User.CompanyStringCompany of the user object.
EWS.User.ConsumerNetIDUnknownConsumer net ID of the user object.
EWS.User.CountryOrRegionStringCountry or region of the .
EWS.User.DefaultMailboxWorkloadsMaskUnknownDefault mailbox workloads mask of the user object.
EWS.User.DepartmentStringDepartment of the user object.
EWS.User.DesiredMailboxWorkloadsUnknownDesired mailbox workloads of the user object.
EWS.User.DesiredMailboxWorkloadsGracePeriodUnknownDesired mailbox workloads grace period of the user object.
EWS.User.DesiredMailboxWorkloadsModifiedUnknownModified desired mailbox workloads of the user object.
EWS.User.DisplayNameStringDisplay name of the user object.
EWS.User.DistinguishedNameStringDistinguished name of the user object.
EWS.User.ExchangeObjectIdStringExchange object ID of the user object.
EWS.User.ExchangeVersionStringExchange version of the user object.
EWS.User.ExternalDirectoryObjectIdStringExternal Directory Object ID of the user object.
EWS.User.FaxStringFax of the user object.
EWS.User.FirstNameStringFirst name of the user object.
EWS.User.GeoCoordinatesUnknownGeo coordinates of the user object.
EWS.User.GuidStringGUID of the user object.
EWS.User.HomePhoneStringHome phone of the user object.
EWS.User.IdStringID of the user object.
EWS.User.IdentityStringIdentity of the user object.
EWS.User.InitialsStringInitials of the user object.
EWS.User.IsCloudCacheBooleanWhether there is a cloud cache for the user object.
EWS.User.IsCloudCacheBlockedBooleanWhether the cloud cache is blocked.
EWS.User.IsCloudCacheProvisioningCompleteBooleanWhether cloud cache provisioning is complete.
EWS.User.IsDirSyncedBooleanWhether the directory is synched.
EWS.User.IsInactiveMailboxBooleanWhether the mailbox is inactive.
EWS.User.IsLinkedBooleanWhether the user object is linked.
EWS.User.IsSecurityPrincipalBooleanWhether there is a security principal.
EWS.User.IsSoftDeletedByDisableBooleanWhether soft delete is disabled and hard (permanent) delete occurs.
EWS.User.IsSoftDeletedByRemoveBooleanWhen the Exchange Online mailbox is deleted (soft delete), this property is set to True.
EWS.User.IsValidBooleanWhether the user object is valid.
EWS.User.LastNameStringLast name of the user object.
EWS.User.LegacyExchangeDNStringLegacy exchange distinguished name of the user object.
EWS.User.LegalAgeGroupUnknownLegal age group of the user object.
EWS.User.LinkedMasterAccountStringLinked master account of the user object.
EWS.User.MailboxLocationsStringMailbox locations of the user object.
EWS.User.MailboxProvisioningConstraintUnknownMailbox provisioning constraint of the user object.
EWS.User.MailboxRegionUnknownMailbox region of the user object.
EWS.User.MailboxRegionLastUpdateTimeUnknownLast time the mailbox region of the user object was updated.
EWS.User.MailboxRegionSuffixStringMailbox region suffix of the user object.
EWS.User.MailboxReleaseStringMailbox release of the user object.
EWS.User.MailboxWorkloadsStringMailbox workloads of the user object.
EWS.User.ManagerUnknownManager of the user object.
EWS.User.MicrosoftOnlineServicesIDStringMicrosoft Online Services ID of the user object.
EWS.User.MobilePhoneStringMobile phone of the user object.
EWS.User.NameStringName of the user object.
EWS.User.NetIDStringNetwork ID of the user object.
EWS.User.NotesStringNotes for the user object.
EWS.User.ObjectCategoryStringObject category of the user object.
EWS.User.ObjectClassStringObject class of the user object.
EWS.User.ObjectStateStringObject state of the user object.
EWS.User.OfficeStringOffice of the user object.
EWS.User.OrganizationIdStringOrganization ID of the user object.
EWS.User.OrganizationalUnitStringOrganizational unit of the user object.
EWS.User.OriginatingServerStringOriginating server of the user object.
EWS.User.PSComputerNameStringPowerShell computer name of the user object.
EWS.User.PSShowComputerNameBooleanWhether to show the PowerShell computer name of the user object.
EWS.User.PagerStringPager of the user object.
EWS.User.PhoneStringPhone of the user object.
EWS.User.PhoneticDisplayNameStringPhonetic display name of the user object.
EWS.User.PostalCodeStringPostal Code of the user object.
EWS.User.PreviousRecipientTypeDetailsStringDetails of the previous recipient type of the user object.
EWS.User.RecipientTypeStringRecipient type of the user object.
EWS.User.RecipientTypeDetailsStringDetails of the recipient type of the user object.
EWS.User.RemotePowerShellEnabledBooleanWhether remote PowerShell is enabled for the user object.
EWS.User.ResetPasswordOnNextLogonBooleanWhether to reset the password on next logon.
EWS.User.RunspaceIdStringRunspace ID of the user object.
EWS.User.SKUAssignedBooleanWhether SKU is assigned.
EWS.User.SamAccountNameStringsAMAccountName of the user object.
EWS.User.SeniorityIndexUnknownSeniority index of the user object.
EWS.User.SidStringSID of the user object.
EWS.User.SimpleDisplayNameStringSimple display name of the user object.
EWS.User.StateOrProvinceStringState or province of the user object.
EWS.User.StreetAddressStringStreet address of the user object.
EWS.User.StsRefreshTokensValidFromDateThe validation start date for the Security Token Service (STS) refresh tokens of the user object.
EWS.User.TelephoneAssistantStringTelephone assistant of the user object.
EWS.User.TitleStringTitle of the user object.
EWS.User.UMDialPlanUnknownUnified Messaging (UM) dial plan of the user object.
EWS.User.UMDtmfMapStringUnified Messaging (UM) dual tone multi-frequency (DTMF) map of the user object.
EWS.User.UpgradeDetailsUnknownUpgrade details of the user object.
EWS.User.UpgradeMessageUnknownUpgrade message of the user object.
EWS.User.UpgradeRequestStringUpgrade request of the user object.
EWS.User.UpgradeStageUnknownUpgrade stage of the user object.
EWS.User.UpgradeStageTimeStampUnknownUpgrade stage time stamp of the user object.
EWS.User.UpgradeStatusStringUpgrade status of the user object.
EWS.User.UserAccountControlStringUser account control of the user object.
EWS.User.UserPrincipalNameStringUser principal name of the user object.
EWS.User.WebPageStringWeb page of the user object.
EWS.User.WhenChangedDateThe date the user object was changed.
EWS.User.WhenChangedUTCDateThe date in UTC format of when the user object was changed.
EWS.User.WhenCreatedDateThe date the user object was created.
EWS.User.WhenCreatedUTCDateThe date in UTC format of when the user object was created.
EWS.User.WhenSoftDeletedUnknownWhen the user object was soft deleted.
EWS.User.WindowsEmailAddressStringWindows email address of the user object.
EWS.User.WindowsLiveIDStringWindows live ID of the user object.
EWS.User.DirectReportsStringDirect reports of the user object.

ews-mailbox-audit-bypass-association-list#


Retrieves information about the AuditBypassEnabled property value for user accounts (on-premises Exchange and the cloud) and computer accounts (on-premises Exchange only).

Base Command#

ews-mailbox-audit-bypass-association-list

Input#

Argument NameDescriptionRequired
identityThe mailbox you want to view.Optional
domain_controllerThe domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). This argument is available only in on-premises Exchange.Optional
limitMaximum number of users to get. A value of 0 means to get all users. Default is 10.Optional

Context Output#

PathTypeDescription
EWS.MailboxAuditBypassAssociation.AuditBypassEnabledBooleanWhether the mailbox audit bypass association is enabled.
EWS.MailboxAuditBypassAssociation.DistinguishedNameStringDistinguished name of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ExchangeObjectIdStringExchange object ID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ExchangeVersionStringThe version of the exchanged server.
EWS.MailboxAuditBypassAssociation.GuidStringThe GUID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.IdStringID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.IdentityStringThe unique identity of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.IsValidBooleanWhether the mailbox audit bypass association property is enabled.
EWS.MailboxAuditBypassAssociation.NameStringName of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ObjectCategoryStringObject category of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ObjectClassStringObject class of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ObjectIdStringObject ID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.ObjectStateStringObject state of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.OrganizationIdStringOrganization ID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.OriginatingServerStringOriginating server of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.PSComputerNameStringPowerShell computer name of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.PSShowComputerNameBooleanWhether to show the computer name of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.RunspaceIdStringRunspace ID of the mailbox audit bypass association.
EWS.MailboxAuditBypassAssociation.WhenChangedunknownThe date the mailbox audit bypass association was changed.
EWS.MailboxAuditBypassAssociation.WhenChangedUTCDateThe date in UTC of when the mailbox audit bypass association was changed.
EWS.MailboxAuditBypassAssociation.WhenCreatedDateThe date the mailbox audit bypass association was created.
EWS.MailboxAuditBypassAssociation.WhenCreatedUTCDateThe date in UTC format of when the mailbox audit bypass association was created.