Skip to main content

Office 365: Create User

Description

Office 365: Create User plugin step creates an Office 365 user.

Permissions:

Following permissions are required to create a security group in Office 365:

Permission typePermission (from least to most privileged)
ApplicationUser.ReadWrite.All, Directory.ReadWrite.All

References: https://docs.microsoft.com/en-us/graph/api/user-post-users?view=graph-rest-1.0

Configurations

No.Field NameDescription
1Step NameName of the step. This name has to be unique in a single workflow.
Connection:For details about app registration, see O365 App Registration, Authentication, and Permissions in Azure AD
2Tenant IDProvide a valid Tenant ID of Microsoft Account.
The data type is string. This field is mandatory.
3Client IDClient ID of the Application created in Microsoft Account.
The data type is string. This field is mandatory.
Client Secret
4Accept Value as variable/staticLeave checkbox unchecked to accept Client Secret value from a field in the previous steps of the stream using a drop down list.
Else enable checkbox for Client Secret field to appear as Text box.
5Client SecretSpecify the Client Secret generated in Microsoft Account.
Client Secret is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). If checkbox above is enabled Client Secret field appears as a Text box and accepts static or variable values. Else if checkbox above is disabled Client Secret field appears as a drop down to select fields from previous steps.
The data type is secure string. This field is mandatory.
6Button: Test ConnectionTest connection with Client ID and Client Secret provided. Verifies whether the connection is established or not.
Note: For the purpose of verification fields coming from previous steps are not allowed since field values can only be accessed when workflow is in running state. Static values and environment variables are allowed.
Input Tab
Input Fields
1Display NameThe name to display in the address book for the user.
The data type is String. This field is mandatory.
2First Name/ Given NameFirst Name or Given Name of the user.
The data type is String. This field is mandatory.
3Last Name/ SurnameLast Name of the user.
The data type is String. This field is mandatory.
4UsernameUnique user name given for the user.
The data type is String. This field is mandatory.
5Domain NameAvailable domain name must be provided or selected from the list populated by clicking the get button.
The data type is String. This field is mandatory.
Note: User Principal name is a combination of User Name and Domain Name. User Principal Name is referred to in the error message returned from the API JSON when an existing User Name is provided while creating a new user.
6GetDisplays list of available domains.
The data type is String. This field is mandatory.
7PasswordSpecify the password for the user. This property is required when a user is created.
The data type is String. This field is mandatory.
8User Must Change Password At Next LogonAllowed values are Yes or No. Provide Yes if the user must change the password on the next login; otherwise No.
The data type is String. This field is mandatory.
9Alias/ Mail Nick NameThe mail alias for the user.
The data type is String. This field is mandatory.
Settings:
10Account EnabledAllowed values are Yes or No. Provide Yes if the account should be enabled; otherwise, No.
The data type is String. This field is mandatory.
11Select Location/ Usage LocationSpecify a valid location e.g. “IN”.
The data type is String. For usageLocation field, it is mandatory to use the abbreviations for countries viz.IN for India and BT for Bhutan, etc.
1. The tool tip for Usage Location is "Enter ISO 3166-1 alpha-2 country code."
2. Reference:
https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes
Contact Info Tab:
1Street AddressStreet location for the user.
The data type is String. This field is optional.
2State/ ProvinceState or province for the user.
The data type is String. This field is optional.
3Country Or RegionCountry or region to which the user belongs.
The data type is String. This field is optional.
4Office LocationOffice Location for the user.
The data type is String. This field is optional.
5CityCity Location for the user.
The data type is String. This field is optional.
6Zip/ Postal CodePostal code of the user.
The data type is String. This field is optional.
7Office Phone/ Business PhoneOffice contact number for the user.
The data type is String. This field is optional.
8Mobile PhoneMobile number for the user.
The data type is String. This field is optional.
9Fax NumberOffice Fax Number.
The data type is String. This field is optional.
10EmailThe Email field sets the proxy address for the user, also known as primary SMTP address or the default reply address. The data type is String. This field is optional.
11Alternate EmailThe field Alternate Email sets the alternate email for the user. The data type is String. This field is optional.
Job Info Tab:
1Job TitleJob designation for the user.
The data type is String. This field is optional.
2DepartmentDepartment of the user.
The data type is String. This field is optional.
3Company NameThe field Company Name sets the company name of the user. The data type is String. This field is optional.
4Employee IDThe field Employee ID sets the employee ID of the user.
The data type is String. This field is optional.
Output Tab
Output Field:
1User EmailSpecify an output field to hold the email address of the user created.In case of step failure, the term userPrincipalName The user principal name (the combination of User Name and Domain Name) is referred in the error message returned from the API JSON when the existing User Name is provided while creating the new user.