Skip to content

mailboxAuditBypassAssociations

Audit Bypass Accounts. Accounts exempted from mailbox audit logging. The mailboxAuditBypassAssociations entity set lives under /exchange/v1.0/mailboxAuditBypassAssociations in the eDiscovery & audit category.

Fact Value
Path /exchange/v1.0/mailboxAuditBypassAssociations
Category eDiscovery & audit
Tier Tier 0, Directory
Read role Compliance.Read.All (Community)
Write role none (read-only)
Backing cmdlets Get-MailboxAuditBypassAssociation, Set-MailboxAuditBypassAssociation
Method Path Synopsis Role Plan
GET /exchange/v1.0/mailboxAuditBypassAssociations List mailboxAuditBypassAssociations entries. Compliance.Read Community
GET /exchange/v1.0/mailboxAuditBypassAssociations/{key} Get a single mailboxAuditBypassAssociations entry by Identity. Compliance.Read Community
PATCH /exchange/v1.0/mailboxAuditBypassAssociations/{key} PATCH /mailboxAuditBypassAssociations/{key} - toggles the AuditBypassEnabled flag for an account via Set-MailboxAuditBypassAssociation. Body { “auditBypassEnabled”: true|false }. Returns 200 + the updated row. Security caveat: bypassing an account removes ALL audit-log entries for its access to any mailbox in the org. Use sparingly for trusted service accounts only. Mailbox.ReadWrite Pro

GET /exchange/v1.0/mailboxAuditBypassAssociations

Section titled “GET /exchange/v1.0/mailboxAuditBypassAssociations”

List mailboxAuditBypassAssociations entries.

Backing cmdlet: Get-MailboxAuditBypassAssociation. Role: Compliance.Read (Community).

Parameter In Type Required Description
resultSize query int Optional: max rows returned (Get-MailboxAuditBypassAssociation -ResultSize; default 1000). Omit to use the cmdlet default; an org with more than 1000 bypass associations is silently truncated otherwise.

Stub auto-generated example for the mailboxAuditBypassAssociations collection. Backing cmdlet: Get-MailboxAuditBypassAssociation. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mailboxAuditBypassAssociations?$top=3 HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxAuditBypassAssociations",
"value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxAuditBypassAssociations/{key}

GET /exchange/v1.0/mailboxAuditBypassAssociations/{key}

Section titled “GET /exchange/v1.0/mailboxAuditBypassAssociations/{key}”

Get a single mailboxAuditBypassAssociations entry by Identity.

Backing cmdlet: Get-MailboxAuditBypassAssociation. Role: Compliance.Read (Community).

Get a single mailboxAuditBypassAssociations entry

Section titled “Get a single mailboxAuditBypassAssociations entry”

Stub auto-generated example for GET /mailboxAuditBypassAssociations/{key}. Backing cmdlet: Get-MailboxAuditBypassAssociation with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mailboxAuditBypassAssociations/{key} HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mailboxAuditBypassAssociations/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mailboxAuditBypassAssociations

PATCH /exchange/v1.0/mailboxAuditBypassAssociations/{key}

Section titled “PATCH /exchange/v1.0/mailboxAuditBypassAssociations/{key}”

PATCH /mailboxAuditBypassAssociations/{key} - toggles the AuditBypassEnabled flag for an account via Set-MailboxAuditBypassAssociation. Body { “auditBypassEnabled”: true|false }. Returns 200 + the updated row. Security caveat: bypassing an account removes ALL audit-log entries for its access to any mailbox in the org. Use sparingly for trusted service accounts only.

Backing cmdlet: Set-MailboxAuditBypassAssociation. Role: Mailbox.ReadWrite (Pro).

Parameter In Type Required Description
auditBypassEnabled body yes
dryRun query bool (switch)

Sets the AuditBypassEnabled flag for a user or computer account via Set-MailboxAuditBypassAssociation. When enabled, the account’s access to any mailbox in the org is excluded from mailbox audit logging.

PATCH /exchange/v1.0/mailboxAuditBypassAssociations/{key} HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
{
"auditBypassEnabled": true
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"Identity": "exonaut-sample-mailboxAuditBypassAssociations@contoso.com",
"Name": "exonaut-sample-mailboxAuditBypassAssociations",
"AuditBypassEnabled": true
}

Notes: Doc-derived from Wiki + write-param allowlist; not live-captured. Body fields are Wiki-valid; values are illustrative.

Related: GET /exchange/v1.0/mailboxAuditBypassAssociations

?dryRun=true previews of any write stay on Community.