Creación de authenticationEventListener

Espacio de nombres: microsoft.graph

Cree un nuevo objeto authenticationEventListener . Puede crear uno de los subtipos siguientes que se derivan de authenticationEventListener.

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) EventListener.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación EventListener.ReadWrite.All No disponible.

Importante

Para el acceso delegado mediante cuentas profesionales o educativas, se debe asignar al administrador un rol de Microsoft Entra compatible o un rol personalizado que conceda los permisos necesarios para esta operación. Esta operación admite los siguientes roles integrados, que proporcionan solo los privilegios mínimos necesarios:

  • Administrador de extensibilidad de autenticación
  • Administrador de la aplicación

Solicitud HTTP

POST /identity/authenticationEventListeners

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto authenticationEventListener .

Puede especificar las siguientes propiedades al crear un objeto authenticationEventListener. Debe especificar la propiedad @odata.type para especificar el tipo de authenticationEventListener que se va a crear; por ejemplo, @odata.type": "microsoft.graph.onTokenIssuanceStartListener".

Propiedad Tipo Descripción
conditions authenticationConditions Condiciones en las que se debe desencadenar esta autenticaciónEventListener. Opcional.
displayName Cadena Nombre para mostrar de la directiva de agente de escucha de eventos de autenticación. Opcional.
handler onTokenIssuanceStartHandler o onFraudProtectionLoadStartHandler Controlador que se va a invocar cuando se cumplen las condiciones. Para onTokenIssuanceStartListener, establezca en onTokenIssuanceStartHandler. Para onFraudProtectionLoadStartListener, establezca en onFraudProtectionLoadStartHandler.
handler onPasswordSubmitHandler Controlador que se va a invocar cuando se cumplen las condiciones. Se puede establecer para el tipo de agente de escucha onPasswordSubmitListener .

Respuesta

Si se ejecuta correctamente, este método devuelve un 201 Created código de respuesta y un objeto authenticationEventListener en el cuerpo de la respuesta. La propiedad @odata.type especifica el tipo del objeto creado.

Ejemplos

Ejemplo 1: Creación de authenticationEventListener

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json
Content-length: 312

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}

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 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "id": "990d94e5-cc8f-4c4b-97b4-27e2678aac28",
    "conditions": {
        "applications": {
            "includeApplications": [
                {
                    "appId": "a13d0fc1-04ab-4ede-b215-63de0174cbb4"
                }
            ]
        }
    },
    "handler": {
        "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtensionHandler",
        "customExtension": {
            "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
        }
    }
}

Ejemplo 2: Habilitar la protección contra fraudes durante el registro con Arkose Labs

Solicitud

En el ejemplo siguiente se muestra una solicitud que habilita la protección contra fraudes durante el registro mediante Arkose Labs.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{   
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener", 
  "conditions": { 
    "applications": { 
      "includeApplications": [ 
        { 
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444" 
        } 
      ] 
    } 
  }, 
  "handler": { 
    "@odata.type": 
"#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler", 
    "signUp": { 
      "@odata.type": "#microsoft.graph.fraudProtectionProviderConfiguration", 
      "fraudProtectionProvider": { 
        "@odata.type": "#microsoft.graph.arkoseFraudProtectionProvider", 
        "id": "6fedd01b-0afb-4a07-967f-d1ccbd81102b" 
      } 
    } 
  } 
}

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 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener",
  "id": "49eb23d9-998b-47df-a462-aa12a20ae5fb",
  "conditions": {
    "applications": {
      "includeApplications": [
        {
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler",
    "signUp": {
      "fraudProtectionProvider": {
        "@odata.type": "#microsoft.graph.arkoseFraudProtectionProvider",
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd"
      }
    }
  }
}

Ejemplo 3: Habilitación de la protección contra fraudes durante el registro con HUMAN Security

Solicitud

En el ejemplo siguiente se muestra una solicitud que habilita la protección contra fraudes durante el registro mediante HUMAN Security.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{   
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener", 
  "conditions": { 
    "applications": { 
      "includeApplications": [ 
        { 
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444" 
        } 
      ] 
    } 
  }, 
  "handler": { 
    "@odata.type": 
"#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler", 
    "signUp": { 
      "@odata.type": "#microsoft.graph.fraudProtectionProviderConfiguration", 
      "fraudProtectionProvider": { 
        "@odata.type": "#microsoft.graph.humanSecurityFraudProtectionProvider", 
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd" 
      } 
    } 
  } 
}

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 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartListener",
  "id": "49eb23d9-998b-47df-a462-aa12a20ae5fb",
  "conditions": {
    "applications": {
      "includeApplications": [
        {
          "appId": "0001111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onFraudProtectionLoadStartExternalUsersAuthHandler",
    "signUp": {
      "isContinueOnProviderErrorEnabled": false,
      "fraudProtectionProvider": {
        "@odata.type": "#microsoft.graph.humanSecurityFraudProtectionProvider",
        "id": "fabe5100-cc02-46c1-bd0e-ce885fe367fd"
      }
    }
  }
}

Ejemplo 4: Creación de un objeto onPasswordSubmitListener

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.onPasswordSubmitListener",
  "displayName": "JIT migration listener",
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "00011111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onPasswordMigrationCustomExtensionHandler",
    "migrationPropertyId": "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_requiresMigration",
    "customExtension": {
      "id": "6fc5012e-7665-43d6-9708-4370863f4e6e"
    }
  }
}

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 201 Created
Content-Type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
  "@odata.type": "#microsoft.graph.onPasswordSubmitListener",
  "id": "4a6cb5f0-1234-5678-abcd-ef9012345678",
  "displayName": "JIT migration listener",
  "authenticationEventsFlowId": null,
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "00011111-aaaa-2222-bbbb-3333cccc4444"
        }
      ]
    }
  },
  "handler": {
    "@odata.type": "#microsoft.graph.onPasswordMigrationCustomExtensionHandler",
    "migrationPropertyId": "extension_b7b1c57b532f40b8b5ed4b7a7ba67401_requiresMigration",
    "configuration": null
  }
}

Ejemplo 5: Creación de un objeto onVerifiedIdClaimValidationListener

Solicitud

En el ejemplo siguiente se muestra la solicitud.

POST https://graph.microsoft.com/v1.0/identity/authenticationEventListeners
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationListener",
  "displayName": "Verified ID Claim Validation Listener",
  "priority": 500,
  "conditions": {
    "applications": {
      "includeAllApplications": false,
      "includeApplications": [
        {
          "appId": "63856651-13d9-4784-9abf-20758d509e19"
        }
      ]
    }
  },
  "authenticationEventsFlowId": "5a8e8f57-82b2-4cbf-b145-3e6e0c154897",
  "handler": {
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtensionHandler",
    "configuration": {
      "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration",
      "clientConfiguration": {
        "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
        "maximumRetries": 1,
        "timeoutInMilliseconds": 2000
      },
      "behaviorOnError": {
        "@odata.type": "#microsoft.graph.customExtensionBehaviorOnError"
      }
    },
    "customExtension": {
      "id": "6a0a3429-be77-0aed-951e-1c8aed62bf8a"
    }
  }
}

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 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/authenticationEventListeners/$entity",
    "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationListener",
    "id": "6a7455ef-0906-bbc3-f902-0f9ab8903082",
    "displayName": "Verified ID Claim Validation Listener",
    "priority": 500,
    "conditions": {
        "applications": {
            "includeAllApplications": false,
            "includeApplications": [
                {
                    "appId": "63856651-13d9-4784-9abf-20758d509e19"
                }
            ]
        }
    },
    "authenticationEventsFlowId": "5a8e8f57-82b2-4cbf-b145-3e6e0c154897",
    "handler": {
        "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtensionHandler",
        "configuration": {
            "@odata.type": "#microsoft.graph.customExtensionOverwriteConfiguration",
            "clientConfiguration": {
                "@odata.type": "#microsoft.graph.customExtensionClientConfiguration",
                "maximumRetries": 1,
                "timeoutInMilliseconds": 2000
            },
            "behaviorOnError": {
                "@odata.type": "#microsoft.graph.customExtensionBehaviorOnError"
            }
        },
        "customExtension": {
            "id": "6a0a3429-be77-0aed-951e-1c8aed62bf8a"
        }
    }
}