title | description | author | ms.localizationpriority | ms.subservice | doc_type |
---|---|---|---|---|---|
Create samlOrWsFedExternalDomainFederation |
Create a new samlOrWsFedExternalDomainFederation object. |
namkedia |
medium |
entra-sign-in |
apiPageType |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Create a new samlOrWsFedExternalDomainFederation object.
[!INCLUDE national-cloud-support]
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
[!INCLUDE rbac-identity-provider-apis]
POST /directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
In the request body, supply a JSON representation of the samlOrWsFedExternalDomainFederation object.
The following table lists the properties that are required when you create the samlOrWsFedExternalDomainFederation.
Property | Type | Description |
---|---|---|
displayName | String | The display name of the SAML/WS-Fed based identity provider. Inherited from identityProviderBase. |
issuerUri | String | Issuer URI of the federation server. Inherited from samlOrWsFedProvider. |
metadataExchangeUri | String | URI of the metadata exchange endpoint used for authentication from rich client applications. Inherited from samlOrWsFedProvider. |
passiveSignInUri | String | URI that web-based clients are directed to when signing in to Microsoft Entra services. Inherited from samlOrWsFedProvider. |
preferredAuthenticationProtocol | String | Preferred authentication protocol. Supported values include saml or wsfed . Inherited from samlOrWsFedProvider. |
signingCertificate | String | Current certificate used to sign tokens passed to the Microsoft identity platform. The certificate is formatted as a Base64 encoded string of the public portion of the federated IdP's token signing certificate and must be compatible with the X509Certificate2 class. This property is used in the following scenarios:
Microsoft Entra ID updates certificates via an autorollover process in which it attempts to retrieve a new certificate from the federation service metadata, 30 days before expiry of the current certificate. If a new certificate isn't available, Microsoft Entra ID monitors the metadata daily and will update the federation settings for the domain when a new certificate is available. |
If successful, this method returns a 201 Created
response code and a samlOrWsFedExternalDomainFederation object in the response body.
POST https://graph.microsoft.com/beta/directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation
Content-Type: application/json
{
"@odata.type": "microsoft.graph.samlOrWsFedExternalDomainFederation",
"issuerUri": "https://contoso.com/issuerUri",
"displayName": "contoso display name",
"metadataExchangeUri": "https://contoso.com/metadataExchangeUri",
"passiveSignInUri": "https://contoso.com/signin",
"preferredAuthenticationProtocol": "wsFed",
"domains": [
{
"@odata.type": "microsoft.graph.externalDomainName",
"id": "contoso.com"
}
],
"signingCertificate": "MIIDADCCAeigAwIBAgIQEX41y8r6"
}
[!INCLUDE sample-code] [!INCLUDE sdk-documentation]
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"id": "3c41f317-9af3-4266-8ccf-26283ceec888",
"displayName": "contoso display name"
}