Skip to content

federationTrusts

Federation Trust. Trust relationship with the Microsoft Federation Gateway. The federationTrusts entity set lives under /exchange/v1.0/federationTrusts in the Sharing & federation category.

Fact Value
Path /exchange/v1.0/federationTrusts
Category Sharing & federation
Tier Tier 3, Mail flow
Read role MailFlow.Read.All (Community)
Write role none (read-only)
Backing cmdlets Get-FederationTrust
Method Path Synopsis Role Plan
GET /exchange/v1.0/federationTrusts List federationTrusts entries. MailFlow.Read Community
GET /exchange/v1.0/federationTrusts/{key} Get a single federationTrusts entry by Identity. MailFlow.Read Community

List federationTrusts entries.

Backing cmdlet: Get-FederationTrust. Role: MailFlow.Read (Community).

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

GET /exchange/v1.0/federationTrusts?$top=3 HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#federationTrusts",
"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/federationTrusts/{key}

Get a single federationTrusts entry by Identity.

Backing cmdlet: Get-FederationTrust. Role: MailFlow.Read (Community).

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

GET /exchange/v1.0/federationTrusts/{key} HTTP/1.1
Authorization: Bearer {token}
HTTP/1.1 200 OK
{
"@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#federationTrusts/$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/federationTrusts