Azureusers¶
Bases: Azure
AzureUsers Component
Overview
This component retrieves a list of users from Azure Active Directory (AAD) using the Microsoft Graph API.
.. table:: Properties
:widths: auto
+------------------------+----------+-----------+---------------------------------------------------------------------------------+ | Name | Required | Summary | +------------------------+----------+-----------+---------------------------------------------------------------------------------+ | credentials | Yes | Dictionary placeholder for Azure AD application credentials. | +------------------------+----------+-----------+---------------------------------------------------------------------------------+ | most_recent (optional) | No | ISO 8601-formatted date and time string to filter users created on or after that date/time. | | +------------------------+----------+-----------+---------------------------------------------------------------------------------+
Returns
A pandas DataFrame containing the retrieved user information. Each row represents an Azure user, and columns might include properties like:
- `objectId`: Unique identifier for the user in AAD.
- `displayName`: User's display name.
- `userPrincipalName`: User's email address (usually the primary login).
- ... (other user properties depending on the AAD response)
Error Handling
- The component raises a `ComponentError` with a detailed message in case of errors during authentication, API calls, or data processing. This error will be surfaced within your Flowtask workflow.
Example:
```yaml
AzureUsers:
recent: '2023-10-01'
```