...
Table of Contents | ||||
---|---|---|---|---|
|
Overview
This Snap performs a search with criteria (if given) and displays the matching entries of the selected type (User or Group) from the given Azure Active Directory instance.
...
Snap Type
Azure Active Directory Search Entries is Read-type Snap that reads the matched entries
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
| Generators | Entry type and key (if desired) to sort the entries. |
Output | Document |
| Any file Formatter followed by File Writer. | List of existing entries of the selected type matching the given criteria. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
Snap Settings
Field | Field Type | Description | ||||
---|---|---|---|---|---|---|
Label* Default Value: Azure Active Directory Search Entries | String | Specify a unique name for the Snap. | ||||
Entity type Default Value: User | Select the object to work with. Available options are:
| |||||
Filter Default Value: N/A
| String/Expression | Specify the search criteria to filter the search for the selected Entity type. Azure Expression Language must be used. | ||||
Properties Default Value: [None] | String/Expression | Specify the properties to be displayed in the output for the user or group. You can add properties corresponding to User or Group from the following links:
Learn more about Advanced query capabilities on Azure AD directory objects.
| ||||
Snap Execution Default Value: | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Multiexcerpt include macro | ||||
---|---|---|---|---|
|
Azure AD Graph API Output Vs Microsoft Graph API Output
Many features in Microsoft Graph API work similarly as the Azure Active Directory Graph APIs. However, a few have been changed and improved. For instance, there is a difference in the entity names in the output preview. The following images highlight the difference in the output.
...
Learn more: https://docs.microsoft.com/en-us/graph/migrate-azure-ad-graph-resource-differences
...
Example
Displaying Specific User Properties in the Output
This example Pipeline demonstrates how you can display specific user properties in the output preview of the Search Entries Snap.
...
Upon validating the Snap, you can view the configured properties (attributes) in the output preview of the Snap.
...
Downloads
Info |
---|
|
...