Créer samlOrWsFedExternalDomainFederation

Espace de noms: microsoft.graph

Créez un objet samlOrWsFedExternalDomainFederation .

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	✅

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	IdentityProvider.ReadWrite.All	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	IdentityProvider.ReadWrite.All	Non disponible.

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. L’administrateur du fournisseur d’identité externe est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

POST /directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.
Content-Type	application/json. Obligatoire.

Corps de la demande

Dans le corps de la requête, fournissez une représentation JSON de l’objet samlOrWsFedExternalDomainFederation .

Le tableau suivant répertorie les propriétés requises lorsque vous créez le samlOrWsFedExternalDomainFederation.

Propriété	Type	Description
displayName	String	Nom complet du fournisseur d’identité basé sur SAML/WS-Fed. Hérité de identityProviderBase.
issuerUri	String	URI de l’émetteur du serveur de fédération. Hérité de samlOrWsFedProvider.
metadataExchangeUri	String	URI du point de terminaison d’échange de métadonnées utilisé pour l’authentification à partir d’applications clientes enrichies. Hérité de samlOrWsFedProvider.
passiveSignInUri	String	URI vers lequel les clients web sont dirigés lors de la connexion à Microsoft Entra services. Hérité de samlOrWsFedProvider.
preferredAuthenticationProtocol	authenticationProtocol	Protocole d’authentification préféré. Les valeurs possibles sont : wsFed, saml. Hérité de samlOrWsFedProvider.
signingCertificate	String	Certificat actuel utilisé pour signer les jetons passés à l’Plateforme d'identités Microsoft. Le certificat est au format d’une chaîne codée en Base64 de la partie publique du certificat de signature de jeton du fournisseur d’identité fédéré et doit être compatible avec la classe X509Certificate2. Cette propriété est utilisée dans les scénarios suivants : si une substitution est requise en dehors de la mise à jour de la substitution automatique un nouveau service de fédération est en cours de configuration si le nouveau certificat de signature de jeton n’est pas présent dans les propriétés de fédération après la mise à jour du certificat de service de fédération. Microsoft Entra ID met à jour les certificats via un processus de substitution automatique dans lequel il tente de récupérer un nouveau certificat à partir des métadonnées du service de fédération, 30 jours avant l’expiration du certificat actuel. Si un nouveau certificat n’est pas disponible, Microsoft Entra ID surveille quotidiennement les métadonnées et met à jour les paramètres de fédération du domaine lorsqu’un nouveau certificat est disponible.

Réponse

Si elle réussit, cette méthode renvoie un 201 Created code de réponse et un objet samlOrWsFedExternalDomainFederation dans le corps de la réponse.

Exemples

Demande

HTTP

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"
}

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const samlOrWsFedExternalDomainFederation = {
    '@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'
};

await client.api('/directory/federationConfigurations/microsoft.graph.samlOrWsFedExternalDomainFederation')
	.version('beta')
	.post(samlOrWsFedExternalDomainFederation);

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": "3c41f317-9af3-4266-8ccf-26283ceec888",
    "displayName": "contoso display name"
}