Enumerar customAuthenticationExtensions

Artículo
10/18/2024

Espacio de nombres: microsoft.graph

Obtenga una lista de los objetos customAuthenticationExtension y sus propiedades. Se admiten los siguientes tipos derivados.

tipo de recurso onTokenIssuanceStartCustomExtension.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	❌

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	CustomAuthenticationExtension.Read.All	CustomAuthenticationExtension.ReadWrite.All
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	CustomAuthenticationExtension.Read.All	CustomAuthenticationExtension.ReadWrite.All

Importante

En escenarios delegados con cuentas profesionales o educativas, al administrador se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación:

Lector global
Administrador de extensibilidad de autenticación
Administrador de la aplicación

Solicitud HTTP

GET /identity/customAuthenticationExtensions

Parámetros de consulta opcionales

Este método admite los $filter parámetros de consulta de OData para ayudar a personalizar la respuesta. Para obtener información general, vea Parámetros de consulta OData.

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un 200 OK código de respuesta y una colección de objetos customAuthenticationExtension en el cuerpo de la respuesta. Se devuelve una propiedad @odata.type para que cada objeto especifique el tipo de customAuthenticationExtension.

Ejemplos

Solicitud

En el ejemplo siguiente se muestra la solicitud.

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


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

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.CustomAuthenticationExtensions.GetAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
});

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



mgc identity custom-authentication-extensions list --filter "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')"

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



// 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"
	  graphidentity "github.com/microsoftgraph/msgraph-sdk-go/identity"
	  //other-imports
)


requestFilter := "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')"

requestParameters := &graphidentity.IdentityCustomAuthenticationExtensionsRequestBuilderGetQueryParameters{
	Filter: &requestFilter,
}
configuration := &graphidentity.IdentityCustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

// To initialize your graphClient, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
customAuthenticationExtensions, err := graphClient.Identity().CustomAuthenticationExtensions().Get(context.Background(), configuration)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

CustomAuthenticationExtensionCollectionResponse result = graphClient.identity().customAuthenticationExtensions().get(requestConfiguration -> {
	requestConfiguration.queryParameters.filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
});

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

let customAuthenticationExtensions = await client.api('/identity/customAuthenticationExtensions')
	.filter('isOf(\'microsoft.graph.onTokenIssuanceStartCustomExtension\')')
	.get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Identity\CustomAuthenticationExtensions\CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration();
$queryParameters = CustomAuthenticationExtensionsRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')";
$requestConfiguration->queryParameters = $queryParameters;


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

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


Import-Module Microsoft.Graph.Identity.SignIns

Get-MgIdentityCustomAuthenticationExtension -Filter "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')"

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
from msgraph.generated.identity.custom_authentication_extensions.custom_authentication_extensions_request_builder import CustomAuthenticationExtensionsRequestBuilder
from kiota_abstractions.base_request_configuration import RequestConfiguration
# To initialize your graph_client, see https://video2.skills-academy.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
query_params = CustomAuthenticationExtensionsRequestBuilder.CustomAuthenticationExtensionsRequestBuilderGetQueryParameters(
		filter = "isOf('microsoft.graph.onTokenIssuanceStartCustomExtension')",
)

request_configuration = RequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.identity.custom_authentication_extensions.get(request_configuration = request_configuration)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

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

Compartir a través de

Enumerar customAuthenticationExtensions

Permissions

Solicitud HTTP

Parámetros de consulta opcionales

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplos

Solicitud

Respuesta

Comentarios

Recursos adicionales