AzureADOperations

Use the AzureADOperations activity to add entries to or delete entries from the connected Microsoft Azure Active Directory.

General

In the General tab, you can establish a connection to a Microsoft Azure Active Directory, and choose between the User or Group objects to use the create and delete operations.

The following table lists the configurations in the General tab of the AzureADOperations Entry activity:

Field Module Property? Description
Name No The name to be displayed as the label for the activity in the process.
Shared Resource Yes Click to select an LDAP Cloud Connection shared resource. The LDAP Cloud Connection shared resource creates a connection between the plug-in and Microsoft Azure Active Directory.

If no matching LDAP Connection shared resources are found, click Create Shared Resource to create one. For more details, see Creating an LDAP Cloud Connection.

Object No Use this drop-down to select one of the following objects:
  • User
  • Group
Operation No Use this drop-down to select one of the following operations:
  • Create: Use this operation to add an entry to the connected Microsoft Azure Active Directory.
  • Delete: Use this operation to delete an entry from the connected Microsoft Azure Active Directory.

Description

In the Description tab, you can enter a short description for the AzureADOperations activity.

Input

In the Input tab, you can specify the entry/entries that you want to create or delete.

The following tables list the input elements in the Input tab of the AzureADOperations activity for the create and delete operations with the user or group objects selected:

Object: User, Operation: Create
Input Item Data Type Description
aboutMe String A freeform text entry field for the user to describe themselves.
accountEnabled Boolean (Mandatory) true if the account is enabled; otherwise, false. This property is required when a user is created.
ageGroup String Sets the age group of the user. The allowed values are null, minor, notAdult and adult.
assignedLicenses Complex The licenses that are assigned to the user. This input item contains the following child elements:
  • disabledPlans (String): A collection of the unique identifiers for plans that have been disabled.
  • skuId (String): The unique identifier for the SKU.
assignedPlans Complex The plans that are assigned to the user. This input item has the following child elements:
  • assignedDateTime (DateTime): The date and time at which the plan was assigned.
  • capabilityStatus (String): Displays the capability status as Enabled or Disabled.
  • service (String): The name of the service.
  • servicePlanId (String): A GUID that identifies the service plan.
birthday DateTime The birthday of the user.
businessPhones String The telephone numbers for the user.

Note: Only one number can be set for this property.

city String The city in which the user is located.
companyName String The company name which the user is associated.
consentProvidedForMinor String Sets whether consent has been obtained for minors. The allowed values are null, granted, denied and notRequired.
country String The country or region in which the user is located.
department String The name for the department in which the user works.
deviceEnrollmentLimit Integer
displayName String (Mandatory) The name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial and last name. This property is required when a user is created and it cannot be cleared during updates.
givenName String The given name (first name) of the user.
hireDate DateTime The hire date of the user.
imAddresses String The instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user.
interests String A list for the user to describe their interests.
jobTitle String The user's job title.
legalAgeGroupClassification String This field is used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties.
mail String The SMTP address for the user.
mailNickname String (Mandatory) The mail alias for the user.
mailboxSettings Complex Settings for the primary mailbox of the signed-in user. This input item has the following child elements:
  • archiveFolder (String): Folder ID of an archive folder for the user.
  • automaticRepliesSetting (Collection): Configuration settings to automatically notify the sender of an incoming email with a message from the signed-in user.
  • language (Collection): The locale information for the user, including the preferred language and country/region.
  • timeZone (String): The default time zone for the user's mailbox.
  • workingHours (Collection): The days of the week and hours in a specific time zone that the user works.
mobilePhone String The primary cellular telephone number for the user.
mySite String The URL for the user's personal site.
officeLocation String The office location in the user's place of business.
onPremisesDomainName String Contains the on-premises domainFQDN. This field is also referred to as dnsDomainName synchronized from the on-premises directory.
onPremisesExtensionAttributes Complex Contains extensionAttributes 1-15 for the user. This input item contains the following child elements:
  • extensionAttribute1 (String): First customizable extension attribute.
  • extensionAttribute2 (String): Second customizable extension attribute.
  • extensionAttribute3 (String): Third customizable extension attribute.
  • extensionAttribute4 (String): Fourth customizable extension attribute.
  • extensionAttribute5 (String): Fifth customizable extension attribute.
  • extensionAttribute6 (String): Sixth customizable extension attribute.
  • extensionAttribute7 (String): Seventh customizable extension attribute.
  • extensionAttribute8 (String): Eighth customizable extension attribute.
  • extensionAttribute9 (String): Ninth customizable extension attribute.
  • extensionAttribute10 (String): Tenth customizable extension attribute.
  • extensionAttribute11 (String): Eleventh customizable extension attribute.
  • extensionAttribute12 (String): Twelfth customizable extension attribute.
  • extensionAttribute13 (String): Thirteenth customizable extension attribute.
  • extensionAttribute14 (String): Fourteenth customizable extension attribute.
  • extensionAttribute15 (String): Fifteenth customizable extension attribute.
onPremisesImmutableId String This property is used to associate an on-premises Active Directory user account to their Azure AD user object.
onPremisesLastSyncDateTime DateTime Indicates the last time at which the object was synced with the on-premises directory.
onPremisesProvisioningErrors Complex Errors when using Microsoft synchronization product during provisioning. This input item contains the following child elements:
  • category (String): Category of the provisioning error.
  • occurredDateTime (DateTime): The date and time at which the error occurred.
  • propertyCausingError (String): Name of the directory property causing the error.
  • value (String): Value of the property causing the error.
onPremisesSamAccountName String Contains the on-premises samAccountName synchronized from the on-premises directory.
onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud.
onPremisesSyncEnabled Boolean This field is true if this object is synced from an on-premises directory, false if this object was originally synced from an on-premises directory but is no longer synced and null if this object has never been synced from an on-premises directory. The default value is null.
onPremisesUserPrincipalName String Contains the on-premises userPrincipalName synchronized from the on-premises directory.
passwordPolicies String Specifies password policies for the user.
passwordProfile Complex (Mandatory) The password profile specified by the user. This input item contains the following child elements:
  • forceChangePasswordNextSignIn (Boolean): true if the user must change her password on the next login; otherwise false.
  • password (String): The password for the user.
    Note: This can be either clear text or obfuscated password using ActiveMatrix BusinessWorks Obfuscation utility to hide the password from people's view.
pastProjects String A list for the user to enumerate their past projects.
postalCode String The postal code for the user's postal address.
preferredLanguage String The preferred language for the user.
preferredName String The preferred name for the user.
provisionedPlans Complex The plans that are provisioned for the user. This input item contains the following child elements:
  • capabilityStatus (String): This property displays the capability status as Enabled or Disabled.
  • provisioningStatus (String): This property displays the provisioning status as Success or Failure.
  • service (String): The name of the service
proxyAddresses String The any operator is required for filter expressions on multi-valued properties.
responsibilities String A list for the user to enumerate their responsibilities.
schools String A list for the user to enumerate the schools they have attended.
skills String A list for the user to enumerate their skills.
state String The state or province in the user's address.
streetAddress String The street address of the user's place of business.
surname String The user's surname (family name or last name).
usageLocation String A two letter country code.
userPrincipalName String (Mandatory) The user principal name (UPN) of the user.
userType String Used to classify user types in your directory.
Object: Group, Operation: Create
Input Item Data Type Description
allowExternalSenders Boolean Indicates if people external to the organization can send messages to the group.
autoSubscribeNewMembers Boolean Indicates if new members added to the group will be auto-subscribed to receive email notifications.
classification String Describes a classification for the group (such as low, medium or high business impact).
createdDateTime DateTime Timestamp of when the group was created.
description String An optional description for the group.
displayName String (Mandatory) The display name for the group.
groupTypes String Specifies the type of group to create.
isSubscribedByMail Boolean Indicates whether the current user is subscribed to receive email conversations.
mail String The SMTP address for the group.
mailEnabled Boolean (Mandatory) Specifies whether the group is mail-enabled.
mailNickname String (Mandatory) The mail alias for the group.
onPremisesLastSyncDateTime DateTime Indicates the last time at which the group was synced with the on-premises directory.
onPremisesProvisioningErrors Complex Errors when using Microsoft synchronization product during provisioning. This input item contains the following child elements:
  • category (String): Category of the provisioning error.
  • occurredDateTime (DateTime): The date and time at which the error occurred.
  • propertyCausingError (String): Name of the directory property causing the error.
  • value (String): Value of the property causing the error.
onPremisesSecurityIdentifier String Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud.
onPremisesSyncEnabled Boolean This value is true if this group is synced from an on-premises directory; false if this group was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory. The default is null.
proxyAddresses String The any operator is required for filter expressions on multi-valued properties.
renewedDateTime DateTime Timestamp of when the group was last renewed.
securityEnabled Boolean (Mandatory) Specifies whether the group is a security group.
unseenCount Integer Count of posts that the current user has not seen since his last visit.
visibility String Specifies the visibility of an Office 365 group.
Object: User, Operation: Delete
Input Item Data Type Description
id String The unique identifier for the user.
userPrincipalName Boolean The user principal name (UPN) of the user.
Object: Group, Operation: Delete
Input Item Data Type Description
id String The unique identifier for the group.

Output

In the Output tab, you can find the operation results. If you performed the Create operation, the output would contain the id of the object created.

In case you performed the Delete operation, the output would display a boolean value to indicate if the object was successfully deleted.

The following table lists the output elements in the Output tab of the AzureADOperations activity for both Create and Delete operations:

Output Item Data Type Description
Result (for Create operation) String The id of the newly created object.
Result (for Delete operation) Boolean A value of true indicates the deletion succeeds.

Fault

In the Fault tab, you can find the error code and error message of the Search Entry activity. See Error Codes for more detailed explanation of errors.

The following table lists error schema elements in the Fault tab of the Search Entry activity:

Error Schema Element Data Type Description
msgCode String Displays the error code.
msg String Displays the error message.