Azure Active Directory

Introduction

This document provides comprehensive instructions for integrating Azure Active Directory (Azure AD) with Automate, a powerful workflow automation platform. Azure AD assists in centrally managing authentication, authorization, and access control for users and devices. Integrating Azure AD with Automate enhances security and simplifies management, especially for organizations utilizing Microsoft Azure cloud services.


What is Azure Active Directory?

Azure Active Directory (Azure AD) is a robust identity management tool designed to centralize authentication and access control for users and devices. It plays a critical role in managing security and access across various applications and services within the Microsoft Azure ecosystem.


Automate Integration with Azure AD

Automate offers a set of pre-built actions that empower users to perform essential operations within Azure AD directly from their workflows. These actions streamline user management tasks and facilitate efficient access control within Azure AD. To use your credentials in Autom, you need to go to Vault page and add your credentials.


Credentials

To use Azure Active Directory actions within Autom Mate, you must first establish secure credentials. Follow the steps below to configure your credentials:

1

Navigate to Vault

Go to the Vault page in Autom Mate and select the option to add a new credential.

2

Define Connector Name

Enter a friendly, unique name for your connector (e.g., AzureADConnector). This name helps in easily identifying the credential for workflows.

3

Authentication Type Selection

Set the Authentication Type to oauth20 to allow secure OAuth 2.0 authentication with Azure Active Directory.

4

Retrieve and Enter Client ID

  • Go to the Application page on the Azure Portal to find your Client ID. This value is essential for the authorization process.

  • For assistance in locating or generating the Client ID, refer to the Azure Registration Quickstart Guide.

5

Provide Client Secret Value

  • In the Azure Portal, generate a Client Secret from the Application page, which Autom Mate will use for secure access to Azure Active Directory.

  • Additional information on creating and retrieving the Client Secret is available in the Azure Client Secret Documentation.

6

Enter Tenant ID

Input the Tenant ID, which can be specified in either GUID or friendly name format. This is the directory tenant from which permissions are requested.

7

Save the Credential

After entering all required fields, save the credential. Your Azure Active Directory credential is now set up and ready for use within Autom Mate actions.


How To Use Actions

Create User

Description and Purpose

The Create User action enables administrators to create a new user account within the Azure Active Directory environment. This action is designed to streamline the onboarding process by automating user account creation with required details in Azure AD.

Usage Instructions

1

Enter User Information

Provide the following fields to configure the user account:

  • Display Name: Input the full display name for the user (required).

  • Password: Set an initial password for the user’s login (required).

  • Account Enabled: Choose if the user account should be enabled or disabled upon creation. Options:

    • Yes

    • No

  • User Principal Name: Enter the unique principal name for the user, typically in the format [email protected] (required).

  • Force Change Password Next Sign In: Indicate if the user should change their password at the next login (required). Options:

    • Yes

    • No

  • Mail Nickname: Enter a nickname for the user’s mail, typically used as an email alias (required).

2

Execute the Action

Run the action to create the new user in Azure AD with the specified configurations. The system will confirm the creation or return any errors encountered.

Input

  • displayName (Required): The full name displayed in Azure AD for the new user.

  • password (Required): Initial password set for the user’s account.

  • accountEnabled (Required): Specifies whether the account is enabled upon creation. Options:

    • Yes

    • No

  • userPrincipalName (Required): Unique identifier for the user, typically following the format [email protected].

  • forceChangePasswordNextSignIn (Required): Specifies if the user should be prompted to change their password at next sign-in. Options:

    • Yes

    • No

  • mailNickname (Required): A nickname or alias for the user’s email address.

Output

Azure Response: The system's response confirming successful user creation or detailing any issues encountered during the creation process.


Get All Users in Organization

Description and Purpose

The Retrieve All Users action enables administrators to obtain a comprehensive list of all user accounts registered within the Azure Active Directory (Azure AD) organization. This action is essential for gaining insights into active user accounts, auditing, and maintaining up-to-date records.

Usage Instructions

1

Execute the Action

Simply run the action to retrieve a complete list of users within the Azure AD organization. No additional configuration or input fields are required.

Input Fields

None Required: This action does not require any input parameters.

Output Fields

Azure Response: The system’s response containing the list of all users registered in the Azure AD environment.


Get User by Mail

Description and Purpose

The Get User by Mail action retrieves specific details of a user in Azure Active Directory based on their email address. This action is useful for quickly accessing user-related information through their registered email.

Usage Instructions

1

Enter the Email Address

In the input field labeled Email, provide the user’s email address for which you wish to retrieve details. This must be a valid email address associated with a user in Azure Active Directory.

2

Execute the Action

Run the action to send a request to Azure Active Directory. The system will retrieve and display the user details based on the provided email.

Input Fields

Email (Required): The email address of the user in Azure Active Directory.

Output Fields

Azure Response: Contains the detailed information returned by Azure, such as user profile details and other associated data. This output can be used for further processing within the workflow.


Update User

Description and Purpose

The Update User action allows users to modify specific attributes and details of an existing user in Azure Active Directory. This action is essential for maintaining up-to-date user information and managing user attributes effectively within the directory.

Usage Instructions

1

Enter the User ID

In the input field labeled User ID, provide the unique identifier of the user whose information needs to be updated. This ID should correspond to an existing user in Azure Active Directory.

2

Execute the Action

Run the action to apply the updates. Azure Active Directory will process the request and update the user information based on the provided User ID.

Input Fields

User ID (Required): The unique identifier of the user whose details need to be updated.

Output Fields

Azure Response: Contains the confirmation and details returned by Azure after successfully updating the user’s information. This response can be used to verify that the update was processed correctly.


Last updated