You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 27, 2021. It is now read-only.
Copy file name to clipboardExpand all lines: website/docs/r/group_settings.md
+68-30Lines changed: 68 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -39,70 +39,108 @@ The following arguments are supported:
39
39
*`email` - (Required; Forces new resource) Email address of the G Suite
40
40
group.
41
41
42
-
*`allow_external_members`
42
+
*`allow_external_members` - (Optional) Identifies whether members external
43
+
to your organization can join the group.
44
+
Valid values are `true` or `false`. Defaults to `false`.
43
45
44
-
*`allow_web_posting`
46
+
*`allow_web_posting` - (Optional) Allows posting from web.
47
+
Valid values are `true` or `false`. Defaults to `true`.
45
48
46
-
*`archive_only`
49
+
*`archive_only` - (Optional) Allows the group to be archived only.
50
+
Valid values are `true` or `false`. Defaults to `false`.
51
+
If true, the `whoCanPostMessage` property is set to `NONE_CAN_POST`.
52
+
When false, updating `whoCanPostMessage` to `NONE_CAN_POST`, results in an error.
47
53
48
-
*`custom_footer_text`
54
+
*`custom_footer_text` - (Optional) Set the content of custom footer text.
55
+
The maximum number of characters is 1,000.
49
56
50
-
*`custom_reply_to`
57
+
*`custom_reply_to` - (Optional) An email address used when replying to a message
58
+
if the replyTo property is set to REPLY_TO_CUSTOM. This address is defined
59
+
by an account administrator.
51
60
52
-
*`description`
61
+
*`description` - (Optional) A longer, human-readable description for the group.
53
62
54
-
*`favorite_replies_on_top`
63
+
*`favorite_replies_on_top` - (Optional) Indicates if favorite replies should be
64
+
displayed above other replies.
65
+
Valid values are `true` or `false`. Defaults to `true`.
55
66
56
-
*`include_custom_footer`
67
+
*`include_custom_footer` - (Optional) Whether to include custom footer.
68
+
Valid values are `true` or `false`. Defaults to `false`.
57
69
58
-
*`include_in_global_address_list`
70
+
*`include_in_global_address_list` - (Optional) Enables the group to be
71
+
included in the Global Address List. For more information, see the help center.
72
+
Valid values are `true` or `false`. Defaults to `true`.
59
73
60
-
*`members_can_post_as_the_group`
74
+
*`members_can_post_as_the_group` - (Optional) Enables members to post messages as the group.
75
+
Valid values are `true` or `false`. Defaults to `false`.
61
76
62
-
*`message_moderation_level`
77
+
*`message_moderation_level` - (Optional) Moderation level of incoming messages.
78
+
The valid values are `MODERATE_ALL_MESSAGES`, `MODERATE_NON_MEMBERS`, `MODERATE_NEW_MEMBERS` and `MODERATE_NONE`. Defaults to `MODERATE_NONE`.
63
79
64
-
*`primary_language`
80
+
*`primary_language` - (Optional) The primary language for group. For a group's primary language use the language tags from
81
+
the G Suite languages found at G Suite Email Settings API Email Language Tags.
65
82
66
-
*`reply_to`
83
+
*`reply_to` - (Optional) Specifies who should the default reply go to.
84
+
The valid values are `REPLY_TO_CUSTOM`, `REPLY_TO_SENDER`, `REPLY_TO_LIST`, `REPLY_TO_OWNER`, `REPLY_TO_IGNORE` and `REPLY_TO_MANAGERS`. Defaults to `REPLY_TO_IGNORE`.
67
85
68
-
*`send_message_deny_notification`
86
+
*`send_message_deny_notification` - (Optional) Allows a member to be notified if the
87
+
member's message to the group is denied by the group owner.
88
+
Valid values are `true` or `false`. Defaults to `false`.
69
89
70
-
*`spam_moderation_level`
90
+
*`spam_moderation_level` - (Optional) Specifies moderation levels for messages detected as spam.
91
+
The valid values are `ALLOW`, `MODERATE`, `SILENTLY_MODERATE` and `REJECT`. Defaults to `MODERATE`.
71
92
72
-
*`who_can_approve_members`
93
+
*`who_can_approve_members` - (Optional) Specifies who can approve members who ask to
94
+
join groups. This permission will be deprecated once it is merged
95
+
into the new whoCanModerateMembers setting.
96
+
The valid values are `ALL_OWNERS_CAN_APPROVE`, `ALL_MANAGERS_CAN_APPROVE`, `ALL_MEMBERS_CAN_APPROVE` and `NONE_CAN_APPROVE`. Defaults to `ALL_MANAGERS_CAN_APPROVE`.
73
97
74
-
*`who_can_assist_content`
98
+
*`who_can_assist_content` - (Optional) Specifies who can moderate metadata.
99
+
The valid values are `NONE`, `OWNERS_ONLY`, `MANAGERS_ONLY`, `OWNERS_AND_MANAGERS` and `ALL_MEMBERS`. Defaults to `NONE`.
75
100
76
-
*`who_can_contact_owner`
101
+
*`who_can_contact_owner` - (Optional) Permission to contact owner of the group via web UI.
102
+
The valid values are `ANYONE_CAN_CONTACT`, `ALL_IN_DOMAIN_CAN_CONTACT`, `ALL_MEMBERS_CAN_CONTACT` and `ALL_MANAGERS_CAN_CONTACT`. Defaults to `ANYONE_CAN_CONTACT`.
77
103
78
-
*`who_can_discover_group`
104
+
*`who_can_discover_group` - (Optional) Specifies the set of users for whom this group
105
+
is discoverable.
106
+
The valid values are `ALL_MEMBERS_CAN_DISCOVER`, `ALL_IN_DOMAIN_CAN_DISCOVER` and `ANYONE_CAN_DISCOVER`. Defaults to `ALL_MEMBERS_CAN_DISCOVER`.
79
107
80
-
*`who_can_join`
108
+
*`who_can_join` - (Optional) Permission to join group.
109
+
The valid values are `ANYONE_CAN_JOIN`, `ALL_IN_DOMAIN_CAN_JOIN`, `INVITED_CAN_JOIN` and `CAN_REQUEST_TO_JOIN`. Defaults to `CAN_REQUEST_TO_JOIN`.
81
110
82
-
*`who_can_leave_group`
111
+
*`who_can_leave_group` - (Optional) Permission to leave the group.
112
+
The valid values are `ALL_MANAGERS_CAN_LEAVE`, `ALL_OWNERS_CAN_LEAVE`, `ALL_MEMBERS_CAN_LEAVE` and `NONE_CAN_LEAVE`. Defaults to `ALL_MEMBERS_CAN_LEAVE`.
83
113
84
-
*`who_can_moderate_content`
114
+
*`who_can_moderate_content` - (Optional) Specifies who can moderate content.
115
+
The valid values are `NONE`, `OWNERS_ONLY`, `OWNERS_AND_MANAGERS` and `ALL_MEMBERS`. Defaults to `OWNERS_AND_MANAGERS`.
85
116
86
-
*`who_can_moderate_members`
117
+
*`who_can_moderate_members` - (Optional) Specifies who can manage members.
118
+
The valid values are `NONE`, `OWNERS_ONLY`, `OWNERS_AND_MANAGERS` and `ALL_MEMBERS`. Defaults to `OWNERS_AND_MANAGERS`.
87
119
88
-
*`who_can_post_message`
120
+
*`who_can_post_message` - (Optional) Permissions to post messages.
121
+
The valid values are `NONE_CAN_POST`, `ALL_MANAGERS_CAN_POST`, `ALL_MEMBERS_CAN_POST`, `ALL_OWNERS_CAN_POST`, `ALL_IN_DOMAIN_CAN_POST` and `ANYONE_CAN_POST`.Defaults to `ANYONE_CAN_POST`.
89
122
90
-
*`who_can_view_group`
123
+
*`who_can_view_group` - (Optional) Permissions to view group messages.
124
+
The valid values are `ANYONE_CAN_VIEW`, `ALL_IN_DOMAIN_CAN_VIEW`, `ALL_MEMBERS_CAN_VIEW`, `ALL_MANAGERS_CAN_VIEW` and `ALL_OWNERS_CAN_VIEW`. Defaults to `ALL_MEMBERS_CAN_VIEW`.
91
125
92
-
*`who_can_view_membership`
126
+
*`who_can_view_membership` - (Optional) Permissions to view membership.
127
+
The valid values are `ALL_IN_DOMAIN_CAN_VIEW`, `ALL_MEMBERS_CAN_VIEW`, `ALL_MANAGERS_CAN_VIEW` and `ALL_OWNERS_CAN_VIEW`. Defaults to `ALL_MEMBERS_CAN_VIEW`.
93
128
94
129
95
130
## Attribute Reference
96
131
97
132
In addition to the above arguments, the following attributes are exported:
98
133
99
-
*`kind`
134
+
*`kind` - The type of the resource. It is always groupsSettings#groups.
100
135
101
-
*`is_archived`
136
+
*`is_archived` - Allows the Group contents to be archived.
137
+
Valid values are `true` or `false`.
102
138
103
-
*`name`
139
+
*`name` - Name of the group, which has a maximum size of 75 characters.
104
140
105
-
*`description`
141
+
*`description` - Description of the group. This property value may be an empty
142
+
string if no group description has been entered. If entered, the maximum group
0 commit comments