Partager via

Répertorier les customAuthenticationExtensions

  • Article

Espace de noms: microsoft.graph

Obtenez la liste des objets customAuthenticationExtension et leurs propriétés. Les types dérivés suivants sont pris en charge.

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) CustomAuthenticationExtension.Read.All CustomAuthenticationExtension.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application CustomAuthenticationExtension.Read.All CustomAuthenticationExtension.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’administrateur 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 :

  • Lecteur général
  • Administrateur de l’extensibilité de l’authentification
  • Administrateur de l'application

Requête HTTP

GET /identity/customAuthenticationExtensions

Paramètres facultatifs de la requête

Cette méthode prend en charge les $filter paramètres de requête OData pour vous aider à personnaliser la réponse. Pour des informations générales, consultez paramètres de la requête OData.

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets customAuthenticationExtension dans le corps de la réponse. Une propriété @odata.type est retournée pour chaque objet afin de spécifier le type de customAuthenticationExtension.

Exemples

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/v1.0/identity/customAuthenticationExtensions?$filter=isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')

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 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/customAuthenticationExtensions",
    "value": [
        {
            "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e",
            "displayName": "onTokenIssuanceStartCustomExtension",
            "description": "Fetch additional claims from custom user store",
            "clientConfiguration": null,
            "authenticationConfiguration": {
                "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
                "resourceId": "api://authenticationeventsAPI.contoso.net/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
            },
            "endpointConfiguration": {
                "@odata.type": "#microsoft.graph.httpRequestEndpoint",
                "targetUrl": "https://authenticationeventsAPI.contoso.net"
            },
            "claimsForTokenConfiguration": [
                {
                    "claimIdInApiResponse": "DateOfBirth"
                },
                {
                    "claimIdInApiResponse": "CustomRoles"
                }
            ]
        }
    ]
}