Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-06-29
Use the Set-FederatedOrganizationIdentifier cmdlet to configure the federated organization identifier for the Exchange organization.
For more details, see Federation.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-FederatedOrganizationIdentifier [-Identity
<OrganizationIdParameter>] [-AccountNamespace
<SmtpDomain>] [-Confirm [<SwitchParameter>]]
[-DefaultDomain <SmtpDomain>] [-DelegationFederationTrust
<FederationTrustIdParameter>] [-DomainController
<Fqdn>] [-Enabled <$true | $false>]
[-OrganizationContact <SmtpAddress>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example configures a federated organization identifier for the Exchange organization.
 Copy Code |
|
|---|---|
Set-FederatedOrganizationIdentifier -DelegationFederationTrust "Microsoft Federation Gateway" -AccountNamespace "Contoso.com" -Enabled $true |
|
EXAMPLE 2
This example temporarily disables federation for the Exchange organization.
| Copy Code |
|
|---|---|
Set-FederatedOrganizationIdentifier -Enabled $false |
|
EXAMPLE 3
This example enables the organization identifier. This enables federation for the Exchange organization.
| Copy Code |
|
|---|---|
Set-FederatedOrganizationIdentifier -Enabled $true |
|
Detailed Description
You must configure a federated organization identifier to create an account namespace for your Exchange organization with the Microsoft Federation Gateway and enable federation for the purpose of sharing calendars or contacts, accessing free/busy information across Exchange organizations, and securing cross-premises email delivery using federated delivery. When you create a federation trust, a value for the AccountNamespace parameter is automatically created with the Microsoft Federation Gateway. The AccountNamespace parameter is a combination of a pre-defined string and the domain specified. For example, if you specify the federated domain contoso.com as the domain, "FYDIBOHF25SPDLT.contoso.com" is automatically created as the value for the AccountNamespace parameter. You can add and remove Additional domain names later by using the Add-FederatedDomain and Remove-FederatedDomain cmdlets.
You can temporarily disable federation by disabling the organization identifier.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Federation trusts" entry in the Exchange and Shell Infrastructure Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
AccountNamespace |
Optional |
Microsoft.Exchange.Data.SmtpDomain |
The AccountNamespace parameter specifies the federated domain to be used to establish the organization identifier with the Microsoft Federation Gateway. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DefaultDomain |
Optional |
Microsoft.Exchange.Data.SmtpDomain |
The DefaultDomain parameter specifies the federated domain used for delegation tokens issued by the Microsoft Federation Gateway for user accounts in the Exchange organization. If the DefaultDomain parameter isn't set, the primary SMTP domain for each user account is used in delegation tokens issued by the Microsoft Federation Gateway. Only a single domain or subdomain for the Exchange organization should be configured, and it applies to all delegation tokens issued for the Exchange organization, for example, contoso.com. |
|
DelegationFederationTrust |
Optional |
Microsoft.Exchange.Configuration.Tasks.FederationTrustIdParameter |
The DelegationFederationTrust parameter specifies the identity of the federation trust to be used by the organization identifier. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Enabled |
Optional |
System.Boolean |
The Enabled parameter specifies whether the organization
identifier is enabled. Valid values include Setting the parameter to |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Identity parameter specifies the federated organization identifier. |
|
OrganizationContact |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The OrganizationContact parameter specifies the SMTP address of the federation contact. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.