Create Group

Create an Office 365 group.

Options

Field Definition Type Required
Group Type

Office 365 Group: Create an Office 365 (aka unified) group.

Security Group: Create a security group.

Dropdown TRUE

Input

Field Definition Type Required
Group
Description An optional description for the group. String FALSE
Display Name The display name for the group. This property is required when a group is created and cannot be cleared during updates. String TRUE
Mail Nickname

The mail alias for the group, unique in the organization. This property must be specified when a group is created.

Note

This field cannot contain a space.

String TRUE
Members Users and groups that are members of this group. This field accepts a list of user or group IDs. List of text FALSE
Owners The owners of the group. The owners are a set of non-admin users who are allowed to modify this object. Limited to 10 owners. This field accepts a list of user IDs. List of text FALSE
Preferred Data Location

The preferred data location for the group. For more information, see OneDrive Online Multi-Geo.

Note

This property can only be set on create or update actions for Office 365 groups. This property can't be set for Security groups.

String FALSE
Security Enabled Specifies whether the group has security enabled. Only Office 365 groups can create and update this property. Boolean FALSE
Visibility Specifies the visibility of an Office 365 group. See group visibility options. Dropdown FALSE
Public Anyone can join the group without needing owner permission. Anyone can view the contents of the group. String FALSE
Private Owner permission is needed to join the group. Non-members cannot view the contents of the group. String FALSE
Hiddenmembership Owner permission is needed to join the group. Non-members cannot view the contents of the group. Non-members cannot see the members of the group. Administrators (global, company, user, and helpdesk) can view the membership of the group. The group appears in the global address book (GAL). String FALSE

Output

Field Definition Type
Group
Classification Describes a classification for the group (such as low, medium or high business impact). Valid values for this property are defined by creating a ClassificationList setting value, based on the groupSettingTemplate definition. See groupSetting and groupSettingTemplate resource types. String
Created Date Time The timestamp of when the group was created. The value cannot be modified and is automatically populated when the group is created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: 2014-01-01T00:00:00Z. String
Description An optional description for the group. String
Display Name The display name for the group. This property is required when a group is created and cannot be cleared during updates. String
Group Types

If the collection contains Unified then the group is an Office 365 group; otherwise it's a security group.

  • ["Unified"] - Office 365 group.

  • [] - Security group.

List of text
Id The unique identifier for the group. String
Mail The SMTP address for the group, for example, serviceadmins@contoso.onmicrosoft.com. String
Mail Enabled Specifies whether the group is mail-enabled. Boolean
Mail Nickname The mail alias for the group, unique in the organization. String
On Premises Last Sync Date Time Indicates the last time at which the group was synced with the on-premises directory. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: 2014-01-01T00:00:00Z. String
On Premises Provisioning Errors Errors when using Microsoft synchronization product during provisioning. List of objects
On Premises Security Identifier Contains the on-premises security identifier (SID) for the group that was synchronized from on-premises to the cloud. String
On Premises Sync Enabled 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 (default). Boolean
Preferred Data Location The preferred data location for the group. For more information, see OneDrive Online Multi-Geo. String
Proxy Addresses Email addresses for the group that direct to the same group mailbox. For example: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. The any operator is required to filter expressions on multi-valued properties. List of text
Renewed Date Time The timestamp of when the group was last renewed. This cannot be modified directly and is only updated through the renew service action. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: 2014-01-01T00:00:00Z. String
Resource Behavior Options A list of options enumerating related resources' behavior for the group. List of text
Resource Provisioning Options A list of options enumerating provisioning options for the group. List of text
Security Enabled Specifies whether the group has security enabled. Boolean
Security Identifier Security identifier of the group, used in Windows scenarios. String
Visibility Specifies the visibility of an Office 365 group. See group visibility options. Visibility can be set only when a group is created; it is not editable. Visibility is supported only for unified groups; it is not supported for security groups. String
Public Anyone can join the group without needing owner permission. Anyone can view the contents of the group. String
Private Owner permission is needed to join the group. Non-members cannot view the contents of the group. String
Hiddenmembership Owner permission is needed to join the group. Non-members cannot view the contents of the group. Non-members cannot see the members of the group. Administrators (global, company, user, and helpdesk) can view the membership of the group. The group appears in the global address book (GAL). String

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management APIs overview