authenticationEventListener resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

To customize the authentication process, listeners can be registered which specify that for some event, on some conditions, some custom logic can be invoked. This is an abstract type from which the following types are derived.

• onTokenIssuanceStartListener resource type resource type
• onInteractiveAuthFlowStartListener resource type resource type
• onAuthenticationMethodLoadStartListener resource type resource type
• onAttributeCollectionListener resource type resource type
• onUserCreateStartListener resource type resource type
• onAttributeCollectionStartListener resource type
• onAttributeCollectionSubmitListener resource type

Note

You can have a maximum of 250 event listeners.

Inherits from entity.

Methods

Method	Return type	Description
List authenticationEventListeners	authenticationEventListener collection	Retrieve a list of the following object types derived from authenticationEventListener: onTokenIssuanceStartListener onInteractiveAuthFlowStartListener onAuthenticationMethodLoadStartListener onAttributeCollectionListener onUserCreateStartListener onAttributeCollectionStartListener onAttributeCollectionSubmitListener
Create authenticationEventListener	authenticationEventListener	Create a new onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener: onTokenIssuanceStartListener onInteractiveAuthFlowStartListener onAuthenticationMethodLoadStartListener onAttributeCollectionListener onUserCreateStartListener onAttributeCollectionStartListener onAttributeCollectionSubmitListener
Get authenticationEventListener	authenticationEventListener	Read the properties and relationships of an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener: onTokenIssuanceStartListener onInteractiveAuthFlowStartListener onAuthenticationMethodLoadStartListener onAttributeCollectionListener onUserCreateStartListener onAttributeCollectionStartListener onAttributeCollectionSubmitListener
Update authenticationEventListener	None	Update the properties of an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener: onTokenIssuanceStartListener onInteractiveAuthFlowStartListener onAuthenticationMethodLoadStartListener onAttributeCollectionListener onUserCreateStartListener onAttributeCollectionStartListener onAttributeCollectionSubmitListener
Delete authenticationEventListener	None	Delete an onTokenIssuanceStartListener object type. The type can be one of the following subtypes derived from authenticationEventListener: onTokenIssuanceStartListener onInteractiveAuthFlowStartListener onAuthenticationMethodLoadStartListener onAttributeCollectionListener onUserCreateStartListener onAttributeCollectionStartListener onAttributeCollectionSubmitListener

Properties

Property	Type	Description
authenticationEventsFlowId	String	The identifier of the authenticationEventsFlow object.
conditions	authenticationConditions	The conditions on which this authenticationEventListener should trigger.
id	String	Identifier for this authenticationEventListener. Inherited from entity.
priority	Int32	The priority of this handler. Between 0 (lower priority) and 1000 (higher priority).

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.authenticationEventListener",
  "id": "String (identifier)",
  "priority": "Integer",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "authenticationEventsFlowId": "String"
}