Mettre à jour les états de la méthode d’authentification

Article
08/01/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Mettez à jour les propriétés des états de méthode d’authentification d’un utilisateur. Utilisez cette API pour mettre à jour les informations suivantes :

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.

Autorisations de mise à jour de l’authentification multifacteur par défaut du système

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

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires où l’utilisateur connecté agit sur un autre utilisateur, il 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. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

Administrateur d’authentification
Administrateur d’authentification privilégié

Autorisations de mise à jour de l’état MFA par utilisateur

Autorisations agissant sur soi-même

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

Autorisations agissant sur d’autres personnes

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Délégué (compte professionnel ou scolaire)	Policy.ReadWrite.AuthenticationMethod	Non disponible.
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	Policy.ReadWrite.AuthenticationMethod	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. Administrateur de stratégie d’authentification est le rôle le moins privilégié pris en charge pour cette opération.

Requête HTTP

Pour mettre à jour les préférences de connexion (authentification multifacteur par défaut du système) pour un utilisateur :

PATCH /users/{id | userPrincipalName}/authentication/signInPreferences

Pour mettre à jour l’état de l’authentification multifacteur par utilisateur pour l’utilisateur connecté :

PATCH /me/authentication/requirements

Pour mettre à jour l’état de l’authentification multifacteur par utilisateur pour un utilisateur :

PATCH /users/{id | userPrincipalName}/authentication/requirements

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 demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété	Type	Description
isSystemPreferredAuthenticationMethodEnabled	Boolean	Indique si les préférences d’informations d’identification du système sont activées.
userPreferredMethodForSecondaryAuthentication	userDefaultAuthenticationMethodType	Méthode de deuxième facteur par défaut utilisée par l’utilisateur lors de la connexion. Si un utilisateur est activé pour l’authentification par défaut du système, cette valeur est ignorée, à l’exception de quelques scénarios où un utilisateur s’authentifie via l’extension NPS ou l’adaptateur ADFS. Les valeurs possibles sont `push`, `oath`, `voiceMobile`, `voiceOfficevoiceAlternateMobile`, `sms`, et`unknownFutureValue`
perUserMfaState	perUserMfaState	État de l’utilisateur pour l’authentification multifacteur par utilisateur. Les valeurs possibles sont `enforced`, `enabled` et `disabled`.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content.

Exemples

Exemple 1 : Mettre à jour la méthode MFA par défaut du système d’un utilisateur

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences
Content-Type: application/json

{
  "userPreferredMethodForSecondaryAuthentication": "oath"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new SignInPreferences
{
	UserPreferredMethodForSecondaryAuthentication = UserDefaultAuthenticationMethodType.Oath,
};

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.SignInPreferences.PatchAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

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).



mgc-beta users authentication sign-in-preferences patch --user-id {user-id} --body '{\
  "userPreferredMethodForSecondaryAuthentication": "oath"\
}\
'

Importante



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewSignInPreferences()
userPreferredMethodForSecondaryAuthentication := graphmodels.OATH_USERDEFAULTAUTHENTICATIONMETHODTYPE 
requestBody.SetUserPreferredMethodForSecondaryAuthentication(&userPreferredMethodForSecondaryAuthentication) 

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
signInPreferences, err := graphClient.Users().ByUserId("user-id").Authentication().SignInPreferences().Patch(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SignInPreferences signInPreferences = new SignInPreferences();
signInPreferences.setUserPreferredMethodForSecondaryAuthentication(UserDefaultAuthenticationMethodType.Oath);
SignInPreferences result = graphClient.users().byUserId("{user-id}").authentication().signInPreferences().patch(signInPreferences);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const signInPreferences = {
  userPreferredMethodForSecondaryAuthentication: 'oath'
};

await client.api('/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/signInPreferences')
	.version('beta')
	.update(signInPreferences);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\SignInPreferences;
use Microsoft\Graph\Beta\Generated\Models\UserDefaultAuthenticationMethodType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new SignInPreferences();
$requestBody->setUserPreferredMethodForSecondaryAuthentication(new UserDefaultAuthenticationMethodType('oath'));

$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->signInPreferences()->patch($requestBody)->wait();

Importante


Import-Module Microsoft.Graph.Beta.Identity.SignIns

$params = @{
	userPreferredMethodForSecondaryAuthentication = "oath"
}

Update-MgBetaUserAuthenticationSignInPreference -UserId $userId -BodyParameter $params

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.sign_in_preferences import SignInPreferences
from msgraph_beta.generated.models.user_default_authentication_method_type import UserDefaultAuthenticationMethodType
# To initialize your graph_client, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = SignInPreferences(
	user_preferred_method_for_secondary_authentication = UserDefaultAuthenticationMethodType.Oath,
)

result = await graph_client.users.by_user_id('user-id').authentication.sign_in_preferences.patch(request_body)

Importante

Réponse

HTTP/1.1 204 No Content

Exemple 2 : Mettre à jour l’état MFA d’un utilisateur

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/requirements
Content-Type: application/json

{
  "perUserMfaState": "disabled"
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new StrongAuthenticationRequirements
{
	PerUserMfaState = PerUserMfaState.Disabled,
};

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].Authentication.Requirements.PatchAsync(requestBody);

Importante



mgc-beta users authentication requirements patch --user-id {user-id} --body '{\
  "perUserMfaState": "disabled"\
}\
'

Importante



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewStrongAuthenticationRequirements()
perUserMfaState := graphmodels.DISABLED_PERUSERMFASTATE 
requestBody.SetPerUserMfaState(&perUserMfaState) 

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
requirements, err := graphClient.Users().ByUserId("user-id").Authentication().Requirements().Patch(context.Background(), requestBody, nil)

Importante


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

StrongAuthenticationRequirements strongAuthenticationRequirements = new StrongAuthenticationRequirements();
strongAuthenticationRequirements.setPerUserMfaState(PerUserMfaState.Disabled);
StrongAuthenticationRequirements result = graphClient.users().byUserId("{user-id}").authentication().requirements().patch(strongAuthenticationRequirements);

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

const strongAuthenticationRequirements = {
  perUserMfaState: 'disabled'
};

await client.api('/users/071cc716-8147-4397-a5ba-b2105951cc0b/authentication/requirements')
	.version('beta')
	.update(strongAuthenticationRequirements);

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\StrongAuthenticationRequirements;
use Microsoft\Graph\Beta\Generated\Models\PerUserMfaState;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new StrongAuthenticationRequirements();
$requestBody->setPerUserMfaState(new PerUserMfaState('disabled'));

$result = $graphServiceClient->users()->byUserId('user-id')->authentication()->requirements()->patch($requestBody)->wait();

Importante

Snippet not available

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.strong_authentication_requirements import StrongAuthenticationRequirements
from msgraph_beta.generated.models.per_user_mfa_state import PerUserMfaState
# To initialize your graph_client, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = StrongAuthenticationRequirements(
	per_user_mfa_state = PerUserMfaState.Disabled,
)

result = await graph_client.users.by_user_id('user-id').authentication.requirements.patch(request_body)

Importante

Réponse

HTTP/1.1 204 No Content

Partager via

Mettre à jour les états de la méthode d’authentification

Autorisations

Autorisations de mise à jour de l’authentification multifacteur par défaut du système

Autorisations de mise à jour de l’état MFA par utilisateur

Autorisations agissant sur soi-même

Autorisations agissant sur d’autres personnes

Requête HTTP

En-têtes de demande

Corps de la demande

Réponse

Exemples

Exemple 1 : Mettre à jour la méthode MFA par défaut du système d’un utilisateur

Demande

Réponse

Exemple 2 : Mettre à jour l’état MFA d’un utilisateur

Demande

Réponse

Commentaires

Ressources supplémentaires