Перечисление authenticationEventListeners

Пространство имен: microsoft.graph

Получите список объектов authenticationEventListener и их свойств. Поддерживаются следующие производные типы:

• onTokenIssuanceStartListener

Этот API доступен в следующих национальных облачных развертываниях.

Глобальная служба	Правительство США L4	Правительство США L5 (DOD)	Китай управляется 21Vianet
✅	✅	✅	❌

Разрешения

Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.

Тип разрешения	Разрешения с наименьшими привилегиями	Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись)	EventListener.Read.All	EventListener.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.	Не поддерживается.
Приложение	EventListener.Read.All	EventListener.ReadWrite.All

Важно!

В делегированных сценариях с рабочими или учебными учетными записями администратору должна быть назначена поддерживаемая Microsoft Entra роль или настраиваемая роль с разрешением поддерживаемой роли. Для этой операции поддерживаются следующие наименее привилегированные роли:

• Глобальный читатель
• Администратор расширяемости проверки подлинности
• Администратор приложений

HTTP-запрос

GET /identity/authenticationEventListeners

Необязательные параметры запросов

Этот метод поддерживает $filter параметры запроса OData и $expand для настройки ответа. Общие сведения см. в статье Параметры запроса OData.

Заголовки запросов

Имя	Описание
Авторизация	Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов authenticationEventListener в тексте отклика. Свойство @odata.type в объекте response указывает тип объекта authenticationEventListener.

Примеры

Запрос

Ниже показан пример запроса.

HTTP

GET https://graph.microsoft.com/v1.0/identity/authenticationEventListeners

C#

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

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.AuthenticationEventListeners.GetAsync();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

CLI

mgc identity authentication-event-listeners list

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Go

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

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


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
authenticationEventListeners, err := graphClient.Identity().AuthenticationEventListeners().Get(context.Background(), nil)

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

AuthenticationEventListenerCollectionResponse result = graphClient.identity().authenticationEventListeners().get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let authenticationEventListeners = await client.api('/identity/authenticationEventListeners')
	.get();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


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


$result = $graphServiceClient->identity()->authenticationEventListeners()->get()->wait();

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

PowerShell

Import-Module Microsoft.Graph.Identity.SignIns

Get-MgIdentityAuthenticationEventListener

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.identity.authentication_event_listeners.get()

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners",
    "value": [
        {
            "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
            "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28",
            "conditions": {
                "applications": {
                    "includeApplications@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners('990d94e5-cc8f-4c4b-97b4-27e2678aac28')/microsoft.graph.onTokenIssuanceStartListener/conditions/applications/includeApplications",
                    "includeApplications": [
                        {
                            "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                        }
                    ]
                }
            },
            "handler": {
                "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
                "configuration": null,
                "customExtension": {
                    "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"
                        }
                    ]
                }
            }
        }
    ]
}