Mettre à jour customAuthenticationExtension

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 .

Mettre à jour les propriétés d’un objet customAuthenticationExtension . Les types dérivés suivants sont actuellement pris en charge.

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

Service global Gouvernement américain L4 Gouvernement américain L5 (DOD) Chine exploitée par 21Vianet
✅ ✅ ✅ ✅

Autorisations

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

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

Importante

Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’administrateur doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :

  • Administrateur d’extensibilité d’authentification
  • Administrateur de l'application

Requête HTTP

PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations.
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.

Vous devez spécifier la propriété lors de la @odata.type mise à jour d’un objet customAuthenticationExtension . Par exemple, pour mettre à jour un type d’objet onTokenIssuanceStartCustomExtension , définissez la @odata.type propriété sur #microsoft.graph.onTokenIssuanceStartCustomExtension.

Propriété Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration Configuration de l’authentification pour cette extension personnalisée. Hérité de customCalloutExtension. Facultatif.
description String Description de l’extension personnalisée. Hérité de customCalloutExtension. Facultatif.
displayName String Nom complet de l’extension personnalisée. Hérité de customCalloutExtension. Facultatif.
handler onAttributeCollectionStartCustomExtensionHandler Gestionnaire à invoquer lorsque les conditions sont remplies. Peut être mis à jour pour le type d’écouteur onAttributeCollectionStartCustomExtensionListener .
handler onAttributeCollectionSubmitCustomExtensionHandler Gestionnaire à invoquer lorsque les conditions sont remplies. Peut être mis à jour pour le type d’écouteur onAttributeCollectionSubmitCustomExtensionListener .
handler onOtpSendCustomExtensionHandler Gestionnaire à invoquer lorsque les conditions sont remplies. Peut être mis à jour pour le type d’écouteur onOtpSendCustomExtensionListener .
handler onTokenIssuanceStartCustomExtensionHandler Gestionnaire à invoquer lorsque les conditions sont remplies. Peut être mis à jour pour le type d’écouteur onTokenIssuanceStartCustomExtensionListener .
endpointConfiguration customExtensionEndpointConfiguration Configuration du point de terminaison d’API que l’extension personnalisée appellera. Hérité de customCalloutExtension. Facultatif.
behaviorOnError customExtensionBehaviorOnError Laisser pour configurer le comportement si l’appel à l’extension d’authentification personnalisée renvoie une erreur. Facultatif.

Réponse

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

Exemples

Exemple 1 : mettre à jour un objet onTokenIssuanceStartCustomExtension

Demande

L’exemple suivant illustre une demande.

PATCH hhttps://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e
Content-Type: application/json
Content-length: 468

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
    "displayName": "onTokenIssuanceStartCustomExtension",
    "description": "Fetch additional claims from custom user store",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.httpRequestEndpoint",
        "targetUrl": "https://authenticationeventsAPI.contoso.com"
    },
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
    },
    "claimsForTokenConfiguration": [
        {
            "claimIdInApiResponse": "DateOfBirth"
        },
        {
            "claimIdInApiResponse": "CustomRoles"
        }
    ]
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content

Exemple 2 : mettre à jour un objet OnVerifiedIdClaimValidationCustomExtension

Demande

L’exemple suivant illustre une demande.

PATCH https://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6a0a3429-be77-0aed-951e-1c8aed62bf8a
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtension",
    "displayName": "Verified ID Claim Validation (updated)",
    "description": "Updated description for Verified ID claim validation"
}

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content